Skip to content

[开源前准备] 完善 README、中文版文档和 Slogan 图 #9

Closed

Description

@david6666666

开源前需要补齐以下几项:

  • README 内容太单薄:需要重写,补充清晰的 Quickstart,并加上演示视频(目前没有)。
  • README 只有英文:默认 README 保持英文,同时提供中文版翻译(如 README_zh.md),两者互相链接。
  • 缺少 Slogan 图:设计一张项目 Slogan / 头图,放在 README 顶部。

相关:#7(v0.1.0 范围和发布准备清单)

Activity

  1. kunkunblueberry commented on Nov 2, 2026

    @kunkunblueberry
    Collaborator

    核查结果:三项已完成,仅剩演示视频

    基于 main@77902d83 逐项核对(文件内容以 UTF-8 读取,控制台乱码是终端编码问题,文件本身正常)。

    1. README 重写 + Quickstart —— 已完成

    README.md(242 行)已由 #8 重写为入门指南,包含:定位说明、安装、模型接入、创建工程、生成与引用、时间线导出、AI 对话、编辑工具、保存与备份、常见问题,并链接到 docs/README.md 文档索引与 docs/guides/video-model-capabilities.md。中文版结构对称。

    2. 中文版 + 互相链接 —— 已完成

    README.md:9        <strong>English</strong> | <a href="README.zh-CN.md">简体中文</a>
    README.zh-CN.md:9  <a href="README.md">English</a> | <strong>简体中文</strong>
    

    README.zh-CN.md 与英文版同结构(同为 242 行)。

    3. Slogan / 头图 —— 已完成

    README.md 顶部即头图,并处理了"减少动态效果"偏好:

    <picture>
      <source media="(prefers-reduced-motion: reduce)" srcset="src/assets/opendirector-readme-logo.png" />
      <img src="src/assets/opendirector-readme-logo.gif" alt="OpenDirector — animated clapperboard logo" width="660" />
    </picture>

    资源文件存在:src/assets/opendirector-readme-logo.gif(892 KB)与 .png(38 KB)。
    注意:这两个素材的授权与作者未记录,见 #16 第 3 节。

    4. 演示视频 —— 未完成

    grep -iE 'video|演示|demo|mp4|youtube|bilibili' README.md README.zh-CN.md 只命中功能描述文本,没有任何演示视频链接或截图序列。

    这一项我无法完成:需要真实模型生成一次完整创作流程(会产生付费调用)并录制,属于 #19 的范畴。若你们已有录制素材,我可以负责嵌入 README(含占位与中英文案)。

    结论

    保持打开,仅剩演示视频一项。其余三项建议在 #19 完成后一并勾选。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

area:docsDocumentation / 文档type:docsDocumentation only

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions