make-readme

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

README Maker

README 生成器

Generate a professional

README.md

for any project — from 50-line minimal to 600-line comprehensive — with shields.io badges, styled headers, and structured sections. Interview the user to determine preferences, then produce the full README in one pass.

为任意项目生成专业的

README.md

文档——从50行极简版到600行完整版，支持shields.io徽章、样式化标题和结构化章节。先与用户沟通确认偏好，再一次性生成完整的README。

Step 1 — Detect Project Context

步骤1 — 检测项目上下文

Before asking, scan the working directory for context clues:

Glob for
```
package.json
```
,
```
pyproject.toml
```
,
```
Cargo.toml
```
,
```
go.mod
```
— Read the first match to extract project name and version as pre-filled defaults
Check if
```
README.md
```
already exists — warn the user before overwriting
Note the primary language from the detected manifest file
For Plugin Collection detection: Glob for
```
*/.claude-plugin/plugin.json
```
,
```
*/package.json
```
in subdirectories. If 3+ sub-manifests are found, pre-select Plugin Collection in Step 2 and note the count.
If no manifest is found, skip pre-filling — rely entirely on user input in Step 2

在提问前，扫描工作目录以获取上下文线索：

全局搜索
```
package.json
```
、
```
pyproject.toml
```
、
```
Cargo.toml
```
、
```
go.mod
```
文件——读取第一个匹配文件，提取项目名称和版本作为预填充默认值
检查是否已存在
```
README.md
```
文件——覆盖前向用户发出警告
从检测到的清单文件中识别主要开发语言
插件集合检测：在子目录中全局搜索
```
*/.claude-plugin/plugin.json
```
、
```
*/package.json
```
。如果找到3个及以上子清单文件，在步骤2中预先选择“插件集合”并记录数量
如果未找到任何清单文件，跳过预填充——完全依赖步骤2中的用户输入

Step 2 — Round 1 Interview (Always)

步骤2 — 第一轮沟通（必选）

Ask 4 questions via

AskUserQuestion

. Pre-select options that match detected context where possible.

#	header	options
1	"Project type"	Library/Package · CLI Tool · Web App/API · Desktop App · Plugin Collection
2	"Language"	Python · JavaScript/Node · Go · Rust
3	"Depth"	Minimal · Standard · Comprehensive
4	"License"	MIT · Apache-2.0 · GPL-3.0 · No license

Project type definitions:

Plugin Collection / Monorepo — a repo containing multiple installable components (plugins, packages, extensions) each with their own versions and descriptions. Automatically enables the component directory table (Step 4) and per-section version badges.

Depth definitions (include as option descriptions):

Minimal — small utilities, internal tools, or anything with one clear use case
Standard — open-source projects expecting contributors and external users
Comprehensive — mature projects with public APIs, active maintainers, or large communities

If depth = Minimal, skip Step 3 and proceed directly to Step 4.

通过

AskUserQuestion

提出4个问题。尽可能根据检测到的上下文预先选择选项。

序号	标题	选项
1	“项目类型”	库/包 · CLI工具 · Web应用/API · 桌面应用 · 插件集合
2	“开发语言”	Python · JavaScript/Node · Go · Rust
3	“文档深度”	极简版 · 标准版 · 完整版
4	“许可证”	MIT · Apache-2.0 · GPL-3.0 · 无许可证

项目类型定义：

插件集合/单体仓库——包含多个可独立安装组件（插件、包、扩展）的仓库，每个组件有自己的版本和描述。自动启用组件目录表格（步骤4）和按章节显示的版本徽章。

文档深度定义（作为选项描述）：

极简版——小型工具、内部工具或功能单一的项目
标准版——面向贡献者和外部用户的开源项目
完整版——拥有公开API、活跃维护者或大型社区的成熟项目

如果选择“极简版”，跳过步骤3直接进入步骤4。

Step 3 — Round 2 Interview (Standard / Comprehensive Only)

步骤3 — 第二轮沟通（仅标准版/完整版）

Ask 4 questions via

AskUserQuestion

#	header	multiSelect	options
1	"Sections"	true	Features list · Demo/Screenshots · Configuration docs · API Reference
2	"Extras"	true	Contributing guide · Roadmap · FAQ · Acknowledgments
3	"Badges"	true	License · CI/Build · Coverage · Version/Release · Downloads · Stars+Forks · Per-section version
4	"Style"	false	Simple · Centered · Styled

Style definitions (include as option descriptions):

Simple — plain
```
# Title
```
with
```
> tagline
```
on next line
Centered —
```
<div align="center">
```
block, title + tagline + badge row centered
Styled — centered + emoji prefix on every H2 and H3 heading. H2 defaults: ✨ Features, 🚀 Quick Start, ⚙️ Configuration, 📖 API, 🤝 Contributing, 🗺 Roadmap, ❓ FAQ, 📄 License. H3 for Plugin Collection components: choose from 🧠 🔍 💻 ✍️ 🤔 🎬 🔧 📦 🛠️ — match to component domain, not alphabetically.

Per-section version badge is pre-selected when project type = Plugin Collection.

通过

AskUserQuestion

提出4个问题：

序号	标题	多选	选项
1	“章节内容”	是	功能列表 · 演示/截图 · 配置文档 · API参考
2	“附加内容”	是	贡献指南 · 路线图 · FAQ · 致谢
3	“徽章类型”	是	许可证 · CI/构建 · 覆盖率 · 版本/发布 · 下载量 · 星标+复刻数 · 按章节版本
4	“样式风格”	否	简洁型 · 居中型 · 美化型

样式风格定义（作为选项描述）：

简洁型——纯文本
```
# 标题
```
，下一行是
```
> 标语
```
居中型——使用
```
<div align="center">
```
块，标题、标语和徽章行居中显示
美化型——居中布局 + 每个H2和H3标题前添加表情前缀。H2默认表情：✨ 功能、🚀 快速开始、⚙️ 配置、📖 API、🤝 贡献、🗺 路线图、❓ FAQ、📄 许可证。插件集合组件的H3表情：从🧠 🔍 💻 ✍️ 🤔 🎬 🔧 📦 🛠️中选择——根据组件领域匹配，而非按字母顺序。

当项目类型为“插件集合”时，自动预先选择“按章节版本”徽章。

Step 4 — Generate README

步骤4 — 生成README

Minimal Structure

极简版结构

Five sections in order: title + tagline, description paragraph (what/who/why), Installation with syntax-highlighted copy-paste command, Usage with a minimal working example plus expected output as a comment, License with SPDX name and link to

LICENSE

file.

按顺序包含5个章节：标题+标语、描述段落（用途/受众/价值）、带语法高亮的复制粘贴安装命令、包含最简运行示例及预期输出（作为注释）的使用说明、带SPDX名称及

LICENSE

文件链接的许可证章节。

Standard / Comprehensive Structure

标准版/完整版结构

Assemble sections in this order, including only those selected in Round 2:

Header block — apply Style from Round 2 (see styles below)
Component directory table — Plugin Collection type only; a compact markdown table listing each component with an anchor link, version, and key skills or features. Glob for sub-directory manifests (
```
*/.claude-plugin/plugin.json
```
,
```
*/package.json
```
) to auto-discover components and pre-fill the table. Place immediately after the header block.
Table of Contents — Comprehensive only; auto-generate anchored links for every H2 section present. Because headings that contain images (version badges) or emoji have unreliable GitHub anchor generation, place
```
<a id="slug"></a>
```
on its own line before each target heading and link via
```
#slug
```
in the TOC. Example:
```
<a id="installation"></a>
## 🚀 Installation  ![v1.0](...)
```
TOC entry:
```
- [Installation](#installation)
```
Description — 2–3 sentences: problem solved, target user, key differentiator
Features (if selected) — bulleted list of capabilities, present tense, parallel form
Demo/Screenshots (if selected) —
```
![Demo](demo.gif)
```
placeholder; instruct user to replace with an actual GIF or screenshot path
Installation — prerequisites block, then numbered install steps
Usage — single example for Standard; multiple headed examples for Comprehensive
Configuration (if selected) — markdown table: Name · Type · Default · Description
API Reference (if selected) — each function/endpoint: signature, one-line description, minimal example
Contributing (if selected) — fork → clone → branch → commit → PR, 5 steps
Roadmap (if selected) —
```
- [ ]
```
checklist of planned features
FAQ (if selected) — H3 questions with short paragraph answers (2–3 entries)
Acknowledgments (if selected) — linked credits
License — SPDX name, link to LICENSE file

For Comprehensive: append

[⬆ back to top](#readme)

after each H2 section.

按以下顺序组合章节，仅包含第二轮沟通中选中的内容：

头部区块——应用第二轮沟通中选择的样式（见下方样式说明）
组件目录表格——仅适用于插件集合类型；紧凑的Markdown表格，列出每个组件的锚点链接、版本和核心功能/特性。全局搜索子目录清单文件（
```
*/.claude-plugin/plugin.json
```
、
```
*/package.json
```
）自动发现组件并预填充表格。放置在头部区块之后。
目录——仅完整版；为所有存在的H2章节自动生成锚点链接。由于包含图片（版本徽章）或表情的标题在GitHub上生成的锚点不可靠，在每个目标标题前单独一行添加
```
<a id="slug"></a>
```
，并在目录中通过
```
#slug
```
链接。示例：
```
<a id="installation"></a>
## 🚀 Installation  ![v1.0](...)
```
目录条目：
```
- [Installation](#installation)
```
描述——2-3句话：解决的问题、目标用户、核心差异化优势
功能（若选中）——项目符号列表形式呈现功能，使用现在时、平行结构
演示/截图（若选中）——
```
![Demo](demo.gif)
```
占位符；提示用户替换为实际GIF或截图路径
安装——前置条件说明，然后是编号安装步骤
使用——标准版为单个示例；完整版为多个带标题的示例
配置（若选中）——Markdown表格：名称 · 类型 · 默认值 · 描述
API参考（若选中）——每个函数/端点：签名、一行描述、最简示例
贡献指南（若选中）——复刻 → 克隆 → 创建分支 → 提交 → 发起PR，共5个步骤
路线图（若选中）——
```
- [ ]
```
格式的计划功能清单
FAQ（若选中）——H3级别的问题搭配简短段落回答（2-3条）
致谢（若选中）——带链接的致谢名单
许可证——SPDX名称、LICENSE文件链接

对于完整版：在每个H2章节末尾添加

[⬆ 返回顶部](#readme)

。

Header Block Styles

头部区块样式

Simple:

# Project Name

followed by

> One-line tagline.

Centered: Wrap title, tagline, and badge row in

<div align="center">

, using

<h1>

for title,

<p>

for tagline, and markdown badge syntax for badges.

Styled: Same as Centered; prepend the relevant emoji to every H2 and H3 per the emoji lists in Step 3. Add

<a id="slug"></a>

before each H2 and H3 that will be linked from the TOC or component directory table.

简洁型：

# 项目名称

后接

> 一行标语。

居中型： 将标题、标语和徽章行包裹在

<div align="center">

中，使用

<h1>

显示标题，

<p>

显示标语，使用Markdown语法显示徽章。

美化型： 与居中型相同；根据步骤3中的表情列表，在每个H2和H3标题前添加对应表情。在所有需要从目录或组件目录表格链接的H2和H3标题前添加

<a id="slug"></a>

。

Badge URLs

徽章URL

Load

references/badges.md

when assembling the badge row — it contains the complete URL patterns for all supported services with substitution instructions. If Language = Other, omit the tech stack badge row unless the user provides their language name.

Per-section version badge (Plugin Collection and Library types):

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

Place inline with the component/section heading, separated by

&nbsp;

markdown

undefined

组装徽章行时加载

references/badges.md

——其中包含所有支持服务的完整URL模板及替换说明。如果开发语言为“其他”，除非用户提供语言名称，否则省略技术栈徽章行。

按章节版本徽章（插件集合和库类型）：

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

与组件/章节标题同行放置，用

&nbsp;

分隔：

markdown

undefined

🧠 plugin-name


Always use `<a id="slug"></a>` before these headings since the badge makes the
auto-generated GitHub anchor unpredictable.


由于徽章会导致GitHub自动生成的锚点不可预测，务必在这些标题前添加`<a id="slug"></a>`。

Step 5 — Write and Summarize

步骤5 — 写入与总结

Write to

README.md

in the current working directory. If

README.md

already exists, confirm overwrite before writing.

After writing, output a concise summary:

File path written
Sections included
Placeholder values the user must replace:
```
USER/REPO
```
,
```
PKG
```
, workflow filename, screenshot/GIF paths, and any description body text

写入当前工作目录下的

README.md

文件。如果

README.md

已存在，需先确认覆盖再写入。

写入完成后，输出简洁总结：

文件写入路径
包含的章节
用户需要替换的占位值：
```
USER/REPO
```
、
```
PKG
```
、工作流文件名、截图/GIF路径及所有描述性文本