Communitygithub.com

thatdudealso/read-me-launcher

为AI代理生成与仓库内容一致、面向受众的README文档(检查+证据+代码检查)。

read-me-launcher 是什么?

Read Me Launcher 是一个专为 AI 代理(如 Claude Code、Cursor 等)设计的技能包,核心目标是生成与目标代码仓库完全匹配的 README 文档。它强制代理在生成文档前先执行 `scripts/inspect-repo.sh` 对仓库进行盘点,避免根据推测编写不存在的功能、脚本或运行时。该技能提供了明确的分类、证据选择、资产生成和代码检查流程,确保 README 中的每个声明都有据可查,并自动过滤可能的密钥泄露和渲染错误。它适用于所有需要代理自主生成高质量 README 的场景,支持内部工具库和公共项目,并提供了丰富的参考文档(如分类法、受众模型、视觉规范等)来指导代理做出风格一致、安全合规的决策。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add thatdudealso/read-me-launcher

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

Read Me Launcher

核心承诺:一份与仓库匹配的 README。

先检查。绝不编造技术栈事实。为受众选择最小且诚实的证据。 在完成前进行渲染和密钥泄露检查。

第 0 步:分类

  1. 运行 scripts/inspect-repo.sh。
  2. 确定 INTERFACE × AUDIENCE × PRIMARY_PROOF (参见 references/taxonomy.md)。
  3. 如果需要,映射到模式简写 (参见 references/audience.md)。

硬性规则(错误)

  • 关于安装/运行/测试的声明必须与检查输出匹配(✓ 已验证 vs ? 未知)
  • 不得编造功能、脚本或运行时
  • <div> / <section> / <center> 内部不得包含代码块
  • README 中引用的本地图片必须存在
  • scripts/check-readme.sh README.md 必须退出码为 0(密钥和渲染检查)
  • 遵循 references/privacy.md 中的隐私规则

强默认设置(非强制要求)

  • 库优先展示工作代码,而非营销宣传
  • 内部仓库优化为操作指南,而非发布宣传
  • 公开 GUI 通常需要一个真实截图
  • 仅当每个素材能证明某些内容时才添加横幅/预览/展示
  • 嵌入栅格图时首选 PNG(参见 references/visuals.md)

风格偏好(警告/首选项)

  • 使用 em 破折号是偏好(PREF);仅在用户希望硬性失败时使用 --strict-style
  • 默认在首屏最多显示约 3 个徽章
  • 避免表情符号泛滥和徽章墙

工作流

  1. 检查 - scripts/inspect-repo.sh
  2. 分类 - 分类法 + 受众
  3. 选择证据 - 最小必要证据
  4. 起草 README - 参见 references/design.md 和 references/section-map.md
  5. 仅在需要时生成资源 - 参见 references/generation.md
  6. 代码检查 - scripts/check-readme.sh README.md
  7. 消费端检查 - 一个陌生人能否从第一屏开始安装?

声明标记(建议在草稿/审查中使用)

标记含义
✓ 已验证通过检查/清单确认
~ 推断合理但未在仓库中明确指出
? 未知不要作为事实呈现
✗ 不支持删除或重写

输出规则

  • 编写 README(仅在必要时生成资源)
  • 优先修正已有的良好 README,而非破坏性重写
  • 不得添加“由 AI 生成”字样
  • 不要夸大“密钥安全”的程度,仅限于 check-readme.sh 扫描的范围;应指出残余风险

捆绑资源

路径使用时机
scripts/inspect-repo.sh始终首先使用
scripts/check-readme.sh始终在完成前使用
references/taxonomy.md分类
references/audience.md证据模式
references/visuals.md图像格式
references/generation.md资源提示/禁止项
references/design.md结构
references/privacy.md公开/私有 + 拒绝列表
references/section-map.md按类型的章节
tests/run-tests.sh本地验证

相关技能