README 生成器

填写项目名称、简介、功能特点、安装方式、使用示例和许可证,选择需要的徽章,自动生成结构清晰的 README.md,支持中文或英文标题和目录,右侧实时预览 GitHub 上的显示效果,复制或下载即可放进项目根目录。

徽章

好的 README 应该回答什么

  1. 这是什么:第一屏用一句话说清楚项目解决什么问题,不要只写项目名。
  2. 为什么用它:列出关键特点,和同类方案相比的优势。截图或动图比文字更直观。
  3. 怎么开始:复制就能运行的安装命令和最小示例,让读者五分钟内跑起来。
  4. 怎么参与:提问、提交 PR 的方式,开发环境怎么搭建,代码规范在哪里。
  5. 能不能用:许可证决定别人能否在商业项目中使用,没有许可证的代码默认保留所有权利。
  • 徽章:徽章由 shields.io 生成,显示 npm 版本、构建状态等实时信息。构建状态徽章默认读取 .github/workflows/ci.yml,文件名不同时需要修改链接。
  • 中英文:面向国际的开源项目可以准备 README.md(英文)和 README.zh-CN.md(中文),在开头互相链接。

项目配置文件可以用 package.json 生成器、.gitignore 生成器、.editorconfig 生成器 生成,CI 配置可以用 GitHub Actions 工作流生成器,检查写法可以用 Markdown 语法检查。

README 生成器常见问题

README 生成器怎么使用?

填写项目名称、GitHub 仓库、一句话简介、npm 包名、标题语言、许可证和作者,勾选需要的徽章,填写功能特点、使用示例、截图地址和路线图,选择是否生成目录、参与贡献和标题居中;右侧预览效果,复制或下载 README.md。

README 应该写什么?

项目是什么、为什么用、怎么安装和使用、怎么参与贡献,以及使用什么许可证。

README 中的徽章怎么加?

勾选需要的徽章,工具会生成 shields.io 的图片链接。

中文项目的 README 用中文还是英文?

面向国内用户可以用中文,开源给国际用户时建议同时提供英文版本。

README 里的目录怎么生成?

勾选“目录”,工具会根据二级标题生成可以点击跳转的目录。

README 生成器的结果应怎样理解?

生成的是通用结构,请按项目实际情况补充配置说明、常见问题等内容;徽章图片由 shields.io 和 GitHub 实时生成,预览时需要能访问这些服务。

输入内容会保存或发给外部服务吗?

所有内容在浏览器本地生成,不会上传。

没有结果或操作失败时先检查什么?

构建状态徽章显示 no status 时,确认工作流文件名是 ci.yml 并且至少运行过一次。

相关工具

GitHub Actions 工作流生成器 · .gitignore 生成器 · CSS Transform 变换生成器 · HMAC 签名生成与验证 · 全部开发工具