Read Me Launcher
核心承诺:一份与仓库匹配的 README。
先检查。绝不编造技术栈事实。为受众选择最小且诚实的证据。 在完成前进行渲染和密钥泄露检查。
第 0 步:分类
- 运行
scripts/inspect-repo.sh。 - 确定 INTERFACE × AUDIENCE × PRIMARY_PROOF (参见 references/taxonomy.md)。
- 如果需要,映射到模式简写 (参见 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 个徽章
- 避免表情符号泛滥和徽章墙
工作流
- 检查 -
scripts/inspect-repo.sh - 分类 - 分类法 + 受众
- 选择证据 - 最小必要证据
- 起草 README - 参见 references/design.md 和 references/section-map.md
- 仅在需要时生成资源 - 参见 references/generation.md
- 代码检查 -
scripts/check-readme.sh README.md - 消费端检查 - 一个陌生人能否从第一屏开始安装?
声明标记(建议在草稿/审查中使用)
| 标记 | 含义 |
|---|---|
| ✓ 已验证 | 通过检查/清单确认 |
| ~ 推断 | 合理但未在仓库中明确指出 |
| ? 未知 | 不要作为事实呈现 |
| ✗ 不支持 | 删除或重写 |
输出规则
- 编写 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 | 本地验证 |