README 生成器

填写项目的基本信息:工具会生成结构化的 README.md 文件(标题、描述、安装、用法、许可证),可直接复制或下载。

示例:

工作原理

填写项目名称(唯一的必填字段)、描述、安装命令、使用示例和许可证。工具会把这些信息整合成结构化的 Markdown 文档,包含标题、目录、带代码块的「安装」和「使用」章节,以及「许可证」章节。生成结果的结构接近大多数 GitHub 贡献指南所推荐的格式。

生成后可以修改 README 吗?

可以,生成的文本是一个可像任何 Markdown 一样编辑的起点:复制或下载文件后,您可以在常用的编辑器中直接添加章节(参与贡献、测试、截图)。

许可证徽章适用于任何许可证吗?

徽章通过 shields.io 服务生成,使用的是您输入的许可证名称原文;对于常见许可证(MIT、Apache-2.0、GPL-3.0 等)可正常显示。对于自定义许可证,徽章仍可使用,但在视觉上不那么标准化。

您填写的所有信息都留在浏览器中:生成这份 README 时不会向服务器发送任何内容。