双语 README 四件套
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_1b56699a/write-best-readme-skill。
技能介绍
问题在哪
不少开源仓库的首页仍然只有几行命令说明:LICENSE 缺失、捐赠入口没配置、英文读者只能自己猜功能。更麻烦的是,各项目的 README 章节各自为政——有人写特性、有人写截图,唯独缺少和同类工具的对照,访客很难在 30 秒内判断「该不该用我这份」。
技能如何工作
write-best-readme-skill 把交付物收成固定四件套:README.md(中文默认)、README_EN.md(章节一一对应、语言徽章互链)、.github/FUNDING.yml、LICENSE(仓库尚无协议时生成 MIT,已有则沿用不改)。
工作流分三步走:扫描——从 package.json、pyproject.toml、源码入口和 docs/ 抽取语言、构建命令、CLI 用法,不以旧 README 复读为准;确认——项目名、H1 生物 emoji、作者署名、Ko-fi 等捐赠平台、宠物投喂文案、对比表竞品名单,拿不准就问;生成——所有仓库共用同一章节顺序,其中对比表为必选节,扫描同行或你指定的竞品,输出功能/价格/开源等矩阵;素材不够的第七、八节整节删除,其余顺序不动。
风格上遵循 Mole 式头部(语言徽章置顶同行)与 Support 段的固定「投喂」措辞;CONTRIBUTING/CHANGELOG 只在 README 里留链接,不整段粘贴。
边界与注意
对比表不明确时技能会停下来问你,不能空交付。已有 README 会先问保留还是重写;LICENSE 已存在不会被覆盖。Banner 图未就位时只能留占位,并会提醒你待 banner 再发布,不会默认帮你推远程。
使用场景
- 新开源项目刚建好仓库,需要在首屏补齐中英文 README、MIT 协议和 GitHub 赞助按钮
- 维护 CLI 工具时想用终端代码块展示真实命令,并按统一章节模板重写旧 README
- 准备在 SkillHub 或 GitHub 发布 Agent Skill,需要同时写好 About 双语句子和 8–20 个 Topics 标签
- 扫描到若干同类库但 README 里没有矩阵表,需要按 Mole 样式补全功能/开源/价格对比
适合人员
- 独立维护 GitHub 项目的作者,希望首页结构与其他仓库一致且自带中英文切换
- 刚把 side project 开源的运营/工程师,缺 LICENSE 和 FUNDING.yml 又不想手写 MIT 全文
- 写 Agent Skill 的维护者,需要 About/Topics 规则与中英 README 章节严格对齐
- README 只有安装说明、没有竞品表的库作者,打算在发布前强制补上对比节