Panshi

开源 README 模板生成器

生成一份彰显认真开源项目的 README —— 徽章、贡献指南、许可说明和清晰结构。

开源项目在争夺注意力,而 README 就是那段推介。有清晰概述、贡献指南和许可说明的项目读起来像在维护、值得信任;只有一行文字的项目读起来像被遗弃,无论代码多好。

这个工具生成为开源而设的结构化 README —— 概述、安装、用法、贡献指南和许可章节,并为徽章留占位。你得到贡献者期望的惯例,让你的项目赢得其代码应得的 star 和 PR。

对应工具

📘README 生成

把项目要点变成一份规范、完整的 README.md。

试用 README 生成 →

常见问题

开源 README 该包含什么? +

概述、安装、用法、贡献指南和许可说明 —— 外加徽章。工具会生成这整套结构。

会加贡献指南吗? +

会。它会起草贡献指南,让新人知道如何参与。

能为全球受众翻译吗? +

能 —— 搭配翻译工具,提供多语言版 README。

相关工具

浏览完整的 工具目录, 或查看全部 磐石服务