🔧

README 生成器

生成专业的 GitHub README.md。

Format: name, description, feature1|feature2 (pipe-separated features)

How to Use

  1. 填写项目信息:名称、描述、主要功能、安装步骤、使用说明、许可证和贡献指南。
  2. 工具生成包含徽章、章节结构和 Markdown 格式的 README.md,遵循 GitHub 最佳实践。
  3. 预览渲染效果,复制 Markdown 内容,粘贴到项目的 README.md 文件中。

Frequently Asked Questions

包含哪些章节?
生成的 README 包含:项目标题和描述、徽章(许可证、版本等)、功能列表、安装说明、使用示例、贡献指南和许可证章节,所有章节均可自定义。
可以禁用某些章节吗?
可以——每个章节都是可选的。将对应字段留空即可在生成的 README 中省略该章节。你可以生成仅包含核心内容的简洁版,也可以生成包含所有章节的完整版。
可以为多个项目复用模板吗?
可以——填写每个项目的信息后生成新的 README。表单会保留上次输入内容直到手动清除,便于为相关项目快速生成不同版本。