name: github-readme description: 该技能用于为软件项目创建或修订 GitHub README，包括章节结构、入门流程、示例和贡献指南。
GitHub README
使用此技能来生成一个帮助访问者快速决定是否使用项目以及如何入门的 README。
目标
一个好的 GitHub README 应该按顺序回答：
- 这个项目是什么？
- 为什么我应该使用它？
- 我现在如何运行它？
- 如何配置常见用例？
- 如何贡献？
工作流程
- 确定受众和主要用例。
- 撰写一个简短的价值导向开场部分。
- 添加一个可运行的快速入门，包含可复制的命令。
- 为 1–3 个最常见任务添加使用示例。
- 仅在核心入门完成后添加配置/参考部分。
- 添加贡献者指南或链接到
CONTRIBUTING.md。 - 运行 README 审计脚本并修复失败项。
- 如果文本仍然感觉密集，之后应用
readability技能。
建议的章节顺序
默认使用此顺序（根据需要调整）：
- 项目名称
- 简短的价值主张
- 功能 / 能力
- 安装
- 快速入门 / 使用
- 配置（如果适用）
- 开发 / 测试
- 贡献
- 许可证
风格约束
- 优先具体示例而非抽象声明。
- 将设置命令放在围栏代码块中。
- 每个章节专注于一个用户问题。
- 避免将设置步骤隐藏在散文深处。
- 使用相对链接用于仓库内文档。
审计脚本
运行捆绑的检查器：
ruby scripts/github_readme_audit.rb README.md
严格模式（更强的章节期望）：
ruby scripts/github_readme_audit.rb README.md --strict
脚本检查：
- H1 标题存在
- 核心入门章节（安装、使用/快速入门）
- 许可证章节
- 设置/使用命令代码块
- 介绍长度护栏
- 在非常长的文件上可选的目录提醒
输出期望
当使用此技能处理用户任务时：
- 返回修订后的 README 内容。
- 总结入门流程中的变化。
- 注明任何需要用户输入的缺失信息（例如，部署步骤或支持策略）。