用途:分析软件项目结构与配置,自动生成较完整的 README.md,作为文档起点。
主要能力:发现 package.json、pyproject.toml、Cargo.toml、go.mod 等关键文件;识别主源码目录、编程语言与框架、依赖、测试框架和 CI/CD 配置;从 LICENSE 判断许可证类型;按项目类型生成标题与描述、功能、安装、使用、许可等必需章节,并按需加入前置条件、开发、测试、贡献、API 文档、截图、路线图、致谢等可选章节。
使用方式:在项目根目录触发该技能,要求生成 README。技能会先用 Glob 查找配置文件与源码目录,用 Read 读取配置,用 Grep 查找测试与 CI 信息,据此判断项目类型(库、应用、CLI 工具等)、语言、依赖、构建与测试命令,再生成内容,最后可写入 README.md 或按反馈调整。
适用场景:Python、Node.js、Rust、Go 及通用结构的项目;适合快速起草标准 README。
限制:无法自动加入截图,需手动补充;可能漏掉非标准文件中的自定义构建流程;不分析代码逻辑来推断功能;对标准项目结构效果最好;输出应作为模板审阅和定制,覆盖已有 README 前建议先备份;未找到项目文件时会要求确认工作目录,信息缺失时用占位符标记。
其它:Apache License 2.0,作者为 GLINCKER 团队,初始版本 1.0.0(2025-01-13)。相关技能包括 changelog-generator、api-doc-generator、license-picker。