5.7 KiB
README 多语言与徽章维护
文件与入口
根目录的 README.md 是中文主页。各语言提供相同范围的项目介绍、真实成片示例、成就、功能、安装、模型配置、折叠 FAQ、文档和联系方式:
| 语言 | 文件 |
|---|---|
| 简体中文 | README.md |
| English | README-EN.md |
| 日本語 | README-JA.md |
| 한국어 | README-KO.md |
| Español | README-ES.md |
| Português(巴西葡语) | README-PT.md |
| Русский | README-RU.md |
| Français | README-FR.md |
不再维护 .github/README.md 和 .github/README-EN.md 两份重复页面。GitHub 优先展示 .github 中的 README,容易让根目录的更新无法显示在仓库首页;参见 GitHub README 规则。README 的个人联系方式仅保留邮箱,不再展示 QQ / 飞书联系方式或二维码入口。
安装、Docker 与排错指南已提供中英文;其他详细技术文档按需翻译,各 README 标注链接目标的语言。README 的翻译范围与应用 UI、字幕和模型的语言能力分别维护,不把八语 README 宣称为八语应用支持。
更新流程
- 在同一个 PR 中同步八个 README 的功能、安装条件和配置说明。中文作为内容基准,其他语言允许自然表达,不必逐句直译。
- 命令、文件名、模型名、参数、下载链接与徽章地址保持一致;不要翻译命令和环境变量。
- 下载入口使用
/releases/latest,平台信息以实际发布资产为准,不在徽章里写死版本号、Stars、Forks 或 Issues 数字。 - 涉及新平台、功能或导出选项时,先核对实现和发布记录,再同步文案。
- 在仓库根目录运行
python3 scripts/check_readmes.py和git diff --check。 - 用 GitHub Markdown 预览核对首屏、语言切换、表格和图片;翻译措辞欢迎母语使用者提交改进。
每次正式发版还要同步八语的版本提示、CLI / MCP ZIP 链接和 wheel 文件名,并与公开 Release 资产核对。scripts/bump_version.py 只更新运行时版本与 CHANGELOG,不会更新这些 README 内容。首次启动、签名和验收状态链接到对应 Release 与安装指南;模型选择以实际服务目录为准,价格和赠送额度链接到服务商页面。耗时与成本保留测试日期和条件,新记录另记版本与输入,不把历史测量写成当前版本的固定承诺。
I18n Documentation Sync 工作流检查八语入口、安装与排错文档的本地链接、图片链接、代码块和徽章一致性,不修改文件,也不自动翻译。外部徽章不作为 CI 的网络依赖,避免第三方服务短暂不可用阻断文档更新。检查通过不代表翻译语义已由母语使用者审校。
成就徽章
AutoClip 的 Trendshift 仓库 ID 是 25801,对应 zhouxiaoka/autoclip 的成就页面。徽章都链接回该页面。
八语 README 页眉只放一枚 Trendshift 官方卡片,对应已记录的 GitHub Trending 成就(repositories/25801)。文案不写具体名次。Python 日榜与全语言日榜已从 README 移除,避免过期排名被读成当前名次。下表仍保留本次核验日期,供维护对照,不要求再贴回 README。
2026-09-21 直接读取该页面与 SVG 接口,核实到以下记录:
| 来源与范围 | 核实记录 | 徽章 |
|---|---|---|
| GitHub Trending(由 Trendshift 记录) | 曾上榜;页面显示达成日期 2026-09-21 | SVG |
| Trendshift · Python | 日榜第 7;首次达成 2026-03-07 | SVG |
| Trendshift · 全语言 | 日榜第 24;首次达成 2026-03-07 | SVG |
这些是平台记录的历史成就,不应写成“当前全球排名”。GitHub Trending 与 Trendshift 自有榜单要区分。页眉只用那一枚官方 Trendshift 卡片,不在 README 文案里写名次数字,避免 GitHub 把数字当成 Issue。后续展示可能随平台记录更新;本表保留本次核验日期。搜索引擎缓存与当次页面读取不一致时,维护优先核对原始页面和接口。
截图中的 Global Rank、周榜、月榜、其他仓库的数字或 TypeScript 分类不能直接复制。只有找到 AutoClip 对应的可验证记录与专属徽章后,才在八语 README 中同步增加。若第三方接口失效,先核实新接口;无法核实时移除失效图片,并保留来源链接,不自行绘制虚构排名。
首页维护范围
README 保持简洁,深入说明链接到现有文档。新增文档链接前确认文件存在;增加语言时同步更新八语导航、上表和 scripts/check_readmes.py 的文件清单。当前脚本只检查本地链接目标是否存在,不检查外部网站可用性、Markdown 锚点或翻译质量。
界面图片的来源与更新说明见 素材说明。个人联系方式仅展示邮箱,维护声明同步八语;无需新增聊天群或即时客服入口。新增中英指南时同步更新检查脚本的 GUIDES 清单。
产品与官网界面
v1.3.1 同时提供八语产品界面和官网。界面词条、检测规则、语言切换与维护方法见 INTERNATIONALIZATION.md。README 的翻译和界面字典需要分别维护。