SuperAPI AI 工具集

init-readme

写作与研究

查看项目

更新于 10-16 00:03

技能介绍

用途:init-readme 用于从一个代码仓库自动生成较为完整、准确的 README.md,适合项目初始化文档、刷新旧文档或补齐说明。\n\n主要能力:它会检查仓库结构、代码与配置,提取项目名、简短标语、可选 logo、徽章、核心功能、安装方式、最小示例、模块结构表等,并按固定结构输出 Markdown。可使用的信息包括 git 元数据(如 git --no-pager log -n 20 --oneline、git --no-pager ls-files、git remote get-url origin)、语言指纹(Go 的 go list -m 与 go.mod、Node 的 package.json、Python 的 pyproject.toml/setup.cfg、Rust 的 Cargo.toml)以及代码与示例目录、logo、CI 提示(如 .github/workflows)。\n\n规则:偏好来自代码与配置的事实,不确定时加“(optional)”或省略;示例应最小可运行;徽章只在能可靠计算时加入;仓库内链接优先使用相对路径;语气友好简洁。\n\n输出结构:标题与标语、徽章、背景介绍、“What is” 小节、Getting Started(安装与最小示例)、结构表、可选技术集成、状态与路线图、贡献与许可证说明,最后以简短友好的结尾收束。生成后应校验链接,移除失效 badge,并只输出最终 Markdown。\n\n限制:资料未提供价格、收费、平台或具体效果等事实;不保证生成的 README 完全无误,仍应以实际代码与测试为准。