双语 README 编写

为一个项目生成两份内容一致的 README：

工作流程

第一步：摸清项目

动笔前先读代码，不靠猜。按顺序查看：

1. 目录结构（顶层 + 主要源码目录）
2. 依赖与元数据：package.json、pyproject.toml、requirements.txt、go.mod、Cargo.toml、pom.xml 等
3. 运行方式：Makefile、scripts 字段、Dockerfile、docker-compose.yml、CLI 入口文件
4. 配置：.env.example、config/ 目录、命令行参数定义
5. 已有文档：旧 README、docs/、LICENSE、CONTRIBUTING.md

如果已有 README，保留其中仍然准确、有价值的内容，并告诉用户哪些会被改写。

如果已有的 README.md 本身是中文，先把它迁移到 README.zh_CN.md（有 git 时用 git mv 保留历史），再在此基础上改写；README.md 留给第三步的英文版。

第二步：写中文版 README.zh_CN.md，然后停下

按下方「结构」写完中文版后，交给用户审核，不要同时写英文版。交付时附一句话说明：哪些地方是根据代码推断的、哪些标了 TODO 需要用户补充。

等用户明确确认（或给出修改意见并改完）后，才进入第三步。

例外：用户明确说"不用审核，直接两份一起写"时，可以合并第二、三步。

第三步：根据中文定稿写英文版 README.md

• 以审核通过的中文版为准，结构、章节顺序、内容一一对应，不增不减
• 写地道的英文，不逐字直译；技术术语用英文社区的通用叫法
• 代码块、命令、路径、配置项原样保留，只翻译代码块中的注释
• 文件顶部的语言切换链接改为英文版写法（见下方）

第四步：自检

• 两份文件章节数量和顺序一致
• 文中的每条命令都能在项目里找到依据（脚本、入口、依赖），能直接复制运行
• 命令执行起来不费事、也没有副作用时，就实际跑一遍，确认输出与文中描述一致
• 相对链接（图片、文档、LICENSE）指向的文件确实存在
• 没有残留的模板占位符；确实不知道的信息统一写成 TODO: ...，并在交付时列出

结构

必写的章节：标题与简介、快速介绍、快速开始。 按需的章节：只有项目里确实存在相关内容时才写，没有就省略，不要硬凑。

# 项目名

[English](README.md) | 简体中文

一句话说明这个项目是什么、给谁用。

## 快速介绍
2～4 句：解决什么问题、为什么要做、适用场景。

## 快速开始
### 环境要求
- 语言/运行时版本、必需的系统依赖

### 安装
（可直接复制的命令）

### 运行
（最小可运行示例 + 预期输出或效果）

## 主要功能            ← 按需：功能点 ≥ 3 个时用列表列出
## 使用示例            ← 按需：快速开始之外的常见用法
## 配置说明            ← 按需：有环境变量/配置文件时，用表格列出 名称 | 说明 | 默认值
## 项目结构            ← 按需：目录层级不直观时，只列主要目录并各附一句说明
## 开发与测试          ← 按需：有测试、lint、构建脚本时
## 常见问题            ← 按需：代码或 issue 中能看出明显的坑时
## 贡献                ← 按需：有 CONTRIBUTING.md 时链接过去，否则一两句即可
## 许可证              ← 仅当存在 LICENSE 文件时，写明协议名并链接

英文版对应标题：

英文版顶部语言切换：English | [简体中文](README.zh_CN.md)

写作原则

• 准确优先：只写能从代码中验证的内容。不编造命令、版本号、徽章、演示地址或截图
• 简洁：README 是入口，不是完整文档。详细内容放 docs/ 并链接过去
• 快速开始要真能跑通：从零开始的读者照着做，应在几分钟内看到结果
• 读者视角：先讲"这是什么、有什么用"，再讲"怎么用"，最后才是实现细节
• 中文排版：中英文之间加空格（如"使用 Python 编写"），中文语境用全角标点，代码与命令用反引号包裹
• 不加多余装饰：不堆 emoji，不加用户没要求的徽章