README 生成器（GitHub 的 README.md）

好的 README 是项目的门面：它说明项目做什么、如何安装和使用、如何参与贡献，也是人们在 GitHub、npm 和 GitLab 上最先看到的内容。这个生成器能把一份简短的表单变成完整的 README.md，包含读者期待的章节——徽章、简介、功能、安装、用法、技术栈、API、贡献、许可证和作者——还可以给出渲染后的 HTML。

使用方法

1. 输入项目名称、一句话简介和 GitHub 仓库（owner/name）。
2. 填写功能、安装命令和用法示例；留空的部分会被跳过。
3. 选择许可证以及额外项目：徽章、截图占位符、贡献指南、目录。
4. 把 Markdown 复制到仓库根目录的 README.md 中。

计算公式

# 名称 → 徽章 → 简介 → About → Features → Built with → Installation → Usage → API → Contributing → License → Author

没有内容的章节会被省略。代码放在围栏长于代码内任何连续反引号的代码块中，因此不会出错。徽章使用 shields.io：静态的许可证徽章（其中的“-”按 shields.io 的要求写成“--”）、npm 版本和下载量，以及 GitHub 的星标、议题和最近提交。目录链接遵循 GitHub 的标题锚点规则（小写、空格变连字符、去掉标点）。HTML 版本由 marked 库以 GitHub 风格模式生成。

示例

示例为 awesome-cli 生成 README：一个许可证徽章和三个 GitHub 徽章、一句话简介、About 段落、三项功能、“Built with”下的 Node.js 和 TypeScript、clone 命令及其后的 npm install -g awesome-cli、用法代码块、贡献步骤、一行 MIT 许可证说明和作者——一共 8 个章节。