用途:为任意项目从零生成或改进 README.md,基于仓库真实数据而非虚构内容。
主要能力:扫描项目目录,收集项目名称与描述、许可证、Git 远程信息、包管理器、CI 配置、社交链接和目录结构(前两层);提供最佳实践指南、README 模板、徽章目录和图表模板;输出经过校验的成品 README。
使用方式:先运行 scripts/scan_project.sh <project-directory> 获取结构化 JSON 元数据;再阅读 references/readme-best-practices.md;以 assets/readme-template.md 为基础替换 {{PLACEHOLDER}} 占位符;从 assets/badges.json 选取徽章(统一使用 style=for-the-badge);最后对照 evals/evals.json 校验,确保无残留占位符、徽章指向真实存在的 shields.io 地址、章节与项目规模相称。若项目含多组件或明确数据流,可参考 assets/diagrams.md 添加图表。
适用场景:库与框架、应用程序、文档或学习仓库、小型工具脚本等,可按项目类型调整语气与章节。
限制:扫描缺失的字段返回空字符串,此时应跳过相关章节或徽章,不得编造;无 CI 工作流则不加构建徽章,无社交链接则不加社交章节。参考脚本会先查本地文件,再通过 GitHub API 查询主页并抓取社交链接,自建版本可先仅用本地文件。