📦 README Auto Generator — README 自动生成器

README Generator 把项目一键变成专业、完备的 README.md——无需手动撰写。

何时使用 ✅ 用本技能： “为我的项目生成 README” “README 过期了，重写” “给开源库写文档” “新仓库没文档” “统一组织内所有 README 格式” “给 README 加上安装与使用章节” “为 CLI 工具生成 API 文档”

❌ 不要用： 需要完整 API 参考 → 用 API 文档生成器 需要多页文档站 → 用文档站生成器（Docusaurus、MkDocs） 需要架构决策记录（ADRs） → 用决策记录技能

工作原理 扫描项目结构——读取目录树，识别项目类型 读取关键配置——检测语言、框架、包管理器、测试框架、CI/CD 分析源码——找出入口、CLI 命令、导出 API、环境变量 检查已有文档——读取现有 README、CONTRIBUTING、CHANGELOG、LICENSE 生成完整 Markdown 文档

自动生成章节 README 自动包含与项目相关的章节：

始终包含 标题与徽章——项目名称、描述、许可证、CI 状态、版本 简介——项目作用与存在理由 目录——长 README 自动添加 安装——按语言给出安装指令

条件生成（自动检测） 前置需求——运行时要求（Node、Python、Java 等） 快速开始——最小运行步骤 使用/CLI——命令、参数、示例（CLI 工具自动识别） API——检测到库/模块时 配置——环境变量、配置文件、dotenv 支持 脚本——npm scripts、Makefile 目标、Justfile 配方 Docker——存在 Dockerfile 或 compose 文件时 测试——如何运行测试 项目结构——目录布局非标准时 贡献——存在 CONTRIBUTING.md 或贡献模式时 许可证——检测到许可证文件时 更新日志——链接到 CHANGELOG.md 或 git tags

使用示例 从零生成 “为当前项目生成 README”→ 扫描整个项目，输出完整 README.md

重新生成 “重新生成 README，但保留自定义章节”→ 合并新生成内容与原有自定义部分

聚焦特定 “聚焦 API 章节生成 README——我有一个 Python 库”→ 深度解析模块导出、类签名、函数参数

语言/框架识别 技能识别并适配： Node.js ← package.json、tsconfig.json、npm/yarn Python ← pyproject.toml、setup.py、requirements Rust ← Cargo.toml Go ← go.mod、go.sum Java/Kotlin ← pom.xml、build.gradle .NET/C# ← .csproj、.sln、NuGet.config Docker ← Dockerfile、compose.yaml 通用 ← Makefile、shell 脚本、任意项目

徽章支持 自动添加： 许可证（来自 LICENSE 文件） 语言版本（来自 SDK/配置文件） CI 状态（检测 GitHub Actions、GitLab CI、CircleCI） 包版本（来自可发布注册表文件）

注意事项 保留自定义内容——更新 README 时，生成区块外内容原样保留 遵循最佳实践——输出符合 Standard README 规范 项目专属——针对 CLI 工具、库、Web 应用、Monorepo 分别适配 开源就绪——格式可直接发布到 GitHub/GitLab