在此运行 完全在你的浏览器里运行,不上传、不登录
README 生成
填入项目名、简介、安装与使用示例,生成一份整洁的 Markdown README。
生成的 README
怎么用
- 输入项目名和一句话简介。
- 填安装命令,可选再加使用示例 —— 两者都会包进代码围栏。
- 选许可证或选无;徽章一行可以自动添加。
- 复制 Markdown 或下载为 README.md。
常见用法
- 新仓库 —— 第一次推送之前就有一份合理的 README,而不是「文档即将补上」。
- 统一团队产出 —— 每个内部项目都从同样的章节顺序开始。
- 开源发布前 —— 一口气补上许可证说明和徽章。
- 内部小工具 —— 给小脚本一个像样的门面,不必打开编辑器排版。
常见问题
问:徽章是从哪来的? 答:徽章是嵌在 Markdown 里的 shields.io 静态图片链接,文件提交到 GitHub 或多数 Git 托管平台后就会渲染;工具本身不会去加载它们。
问:能加 Contributing 或 Tests 等章节吗? 答:生成的是纯 Markdown,复制进编辑器继续扩展即可。工具把常用章节顺序固定下来,方便你在稳定的基础上追加。
问:许可证选「无」会输出什么? 答:会输出一段说明:尚未选择许可证,默认保留所有权利 —— 这正是未授权公开仓库的准确状态。
你的数据留在这台设备上
README 生成 完全在本地运行。你粘贴或拖入的一切都由你自己的浏览器处理,不会被传走。我们的服务器不保存任何东西——关掉标签页就没了。
你输入的内容不会发往服务器、不被记录,也不用于分析统计。首次加载之后即使断网,这个页面照样能用。