用途:扫描代码库并生成或更新符合最佳实践的 README.md,让新人在 60 秒内了解项目做什么、如何运行、如何使用与如何贡献。
主要能力:分三阶段工作。阶段一深度扫描:查看目录结构、各语言包清单(如 package.json、Cargo.toml、pyproject.toml、go.mod)、可用脚本与入口、配置与 CI 文件(如 .github/workflows/、Dockerfile、.env.example、Makefile)、现有文档与测试目录、Git 信息,据此提取项目名、一行描述、语言运行时、依赖、安装/运行/测试/构建命令、环境变量、CI/CD 与许可证等事实。阶段二评估:若已有 README,按质量清单找出缺失段落、失效信息、不准确描述、结构问题与缺少快速开始,并先向用户给出简要评估。阶段三撰写/重写:按规范结构输出标题与徽章、一句话简介、关键功能、快速开始、安装、用法、配置、项目结构、API 文档、开发、部署、技术栈、路线图、贡献与许可证等章节,并按项目类型(库、CLI、Web 应用、API、monorepo)调整重点。
使用方式与限制:资料未给出具体调用命令,仅说明最终输出为写入项目根目录的 README.md 文件,并附评估与验证说明(无法验证的命令、假设与需用户确认之处)。每次 README 声明必须来自代码库,不得编造功能或命令;徽章须真实可解析,不虚构 URL;不保留 TODO 等占位文本;仅在有 LICENSE 时才写许可证段落。避免把其他项目内容复制过来、避免徽章过多、避免无日期截图与“即将推出”段落。所有事实以实际代码为准,缺失信息应明确标注而非臆测。