make-readme

README 生成器

为任何项目生成专业的 README.md——从 50 行的精简版本到 600 行的详尽版本——包含 shields.io 徽章、样式化标题和结构化章节。通过访谈了解用户的偏好，然后一次性生成完整 README。

第 1 步 — 检测项目上下文

提问前，先扫描工作目录，查找上下文线索：

• Glob 查找 package.json、pyproject.toml、Cargo.toml、go.mod——读取第一个匹配项，提取项目名称和版本作为预填默认值
• 检查是否已存在 README.md——覆盖前提醒用户
• 根据检测到的清单文件记录主要语言
• 检测插件集合：Glob 查找 */.claude-plugin/plugin.json 和子目录中的 */package.json。如果找到 3 个或更多子清单，则在第 2 步中预选插件集合，并注明数量。
• 如果未找到清单文件，则跳过预填——完全依赖用户在第 2 步中的输入

第 2 步 — 第一轮访谈（始终进行）

通过 AskUserQuestion 提出 4 个问题。尽可能预选与检测到的上下文相符的选项。

#	header	options
1	"项目类型"	库/包 · CLI 工具 · Web 应用/API · 桌面应用 · 插件集合
2	"语言"	Python · JavaScript/Node · Go · Rust
3	"详尽程度"	精简 · 标准 · 详尽
4	"许可证"	MIT · Apache-2.0 · GPL-3.0 · 无许可证

项目类型定义：

• 插件集合 / Monorepo — 包含多个可安装组件（插件、包、扩展）的仓库，每个组件都有自己的版本和描述。自动启用组件目录表（第 4 步）和各章节版本徽章。

详尽程度定义（作为选项描述提供）：

• 精简 — 小型实用工具、内部工具，或只有一个明确用途的项目
• 标准 — 面向贡献者和外部用户的开源项目
• 详尽 — 具有公共 API、活跃维护者或大型社区的成熟项目

如果详尽程度为精简，则跳过第 3 步，直接进入第 4 步。

第 3 步 — 第二轮访谈（仅限标准 / 详尽）

通过 AskUserQuestion 提出 4 个问题：

#	header	multiSelect	options
1	"章节"	true	功能列表 · 演示/截图 · 配置文档 · API 参考
2	"附加内容"	true	贡献指南 · 路线图 · 常见问题 · 致谢
3	"徽章"	true	许可证 · CI/构建 · 覆盖率 · 版本/发布 · 下载量 · Stars+Forks · 各章节版本
4	"样式"	false	简洁 · 居中 · 样式化

样式定义（作为选项描述提供）：

• 简洁 — 使用普通的 # Title，下一行写 > tagline
• 居中 — 使用 <div align="center"> 区块，将标题、标语和徽章行居中
• 样式化 — 居中布局 + 每个 H2 和 H3 标题前添加表情符号。H2 默认值： ✨ 功能、🚀 快速开始、⚙️ 配置、📖 API、🤝 贡献、 🗺 路线图、❓ 常见问题、📄 许可证。插件集合组件的 H3：从 🧠 🔍 💻 ✍️ 🤔 🎬 🔧 📦 🛠️ 中选择——根据组件领域匹配，而非按字母顺序选择。

当项目类型为插件集合时，默认预选各章节版本徽章。

第 4 步 — 生成 README

精简结构

按顺序包含五个章节：标题 + 标语、描述段落（说明是什么、面向谁、为什么）、安装（包含带语法高亮且可直接复制粘贴的命令）、用法（包含最简可运行示例和作为注释的预期输出）、许可证（包含 SPDX 名称和指向 LICENSE 文件的链接）。

标准 / 完整结构

按以下顺序组装各部分，只包含第 2 轮中选定的部分：

1. 标题区块 — 应用第 2 轮中的样式（参见下方样式）
2. 组件目录表 — 仅适用于插件集合类型；使用紧凑的 Markdown 表格，列出每个组件的锚点链接、版本和关键技能或功能。使用 Glob 搜索子目录中的清单（*/.claude-plugin/plugin.json、*/package.json），自动发现组件并预填此表。将表格放在标题区块之后。
3. 目录 — 仅适用于完整结构；为所有现有的 H2 标题自动生成锚点链接。包含图片（版本徽章）或表情符号的标题，其 GitHub 锚点生成不可靠，因此请在每个目标标题前的单独一行放置 <a id="slug"></a>，并在目录中使用 #slug 链接。 示例：

   <a id="installation"></a>
   ## 🚀 Installation  ![v1.0](...)
   

   目录条目：- [安装](#installation)
4. 简介 — 用 2–3 个句子说明解决的问题、目标用户和主要差异化优势
5. 功能（如果选中）— 以项目符号列出功能，使用现在时，保持句式平行
6. 演示 / 截图（如果选中）— 使用 ![Demo](demo.gif) 占位符；提示用户替换为实际 GIF 或截图路径
7. 安装 — 先列出先决条件，再列出带编号的安装步骤
8. 用法 — 标准结构提供一个示例；完整结构提供多个带标题的示例
9. 配置（如果选中）— Markdown 表格：名称 · 类型 · 默认值 · 描述
10. API 参考（如果选中）— 每个函数 / 端点包含：签名、一行说明、最简示例
11. 贡献（如果选中）— 按照 fork → clone → branch → commit → PR 的顺序列出 5 个步骤
12. 路线图（如果选中）— 使用 - [ ] 列出计划功能
13. 常见问题（如果选中）— 使用 H3 标题列出问题，并用简短段落回答（2–3 项）
14. 致谢（如果选中）— 添加带链接的鸣谢
15. 许可证 — SPDX 名称，以及指向 LICENSE 文件的链接

完整结构中，每个 H2 部分后添加 [⬆ 返回顶部](#readme)。

标题区块样式

简单： 使用 # Project Name，后接 > One-line tagline.

居中： 使用 <div align="center"> 包裹标题、标语和徽章行；标题使用 <h1>，标语使用 <p>，徽章使用 Markdown 语法。

样式化： 与居中样式相同；根据第 3 步的表情符号列表，为每个 H2 和 H3 标题添加相应表情符号。对于目录或组件目录表会链接到的每个 H2 和 H3 标题，在其前添加 <a id="slug"></a>。

徽章 URL

组装徽章行时，加载 references/badges.md — 其中包含所有受支持服务的完整 URL 格式及替换说明。如果语言为 Other，则省略技术栈徽章行，除非用户提供语言名称。

各部分版本徽章（插件集合和库类型）：

![v{VERSION}](https://img.shields.io/badge/v{VERSION}-blue?style=flat-square)

将其与组件 / 部分标题放在同一行，中间以   分隔：

### 🧠 plugin-name   ![v0.7.5](https://img.shields.io/badge/v0.7.5-blue?style=flat-square)

这些标题前始终使用 <a id="slug"></a>，因为徽章会导致 GitHub 自动生成的锚点不可靠。

第 5 步 — 编写并总结

将内容写入当前工作目录中的 README.md。如果 README.md 已存在，请在写入前确认是否覆盖。

写入后，输出简洁的总结：

• 写入的文件路径
• 包含的部分
• 用户必须替换的占位值：USER/REPO、PKG、工作流文件名、截图 / GIF 路径，以及任何描述正文