每个开源项目都需要一份像样的 README,但手写又长又容易漏。本工具的做法是:在左侧填好项目信息,右侧立刻得到一份排版规范的 Markdown README。
三步走
- 填写项目名称、描述、语言。
- 补充特性(每行一条)、安装命令、用法示例。
- 点「生成 README」,复制或下载
.md即可。
为什么用生成器而不是从零手写
- 结构稳:标题 / 特性 / 安装 / 用法 / 贡献 / 许可证 一应俱全,不会漏 section。
- 中英双语:可切换 English / 中文模板。
- 隐私:全部在浏览器本地计算,项目信息不上传服务器。
下一步
生成后建议再手补一段「截图 / Demo」和「路线图」,让仓库更有说服力。需要更多写作思路看《怎么写好一份 README》。
立即使用 AI README 生成器 →