SuperAPI AI 工具集

readme-generator

通用与其它

查看项目

更新于 10-16 09:47

技能介绍

用途:为当前项目生成一份简洁、诚实的 README.md,让陌生读者在 30 秒内弄清三件事:这是什么、如何安装、如何使用。

主要能力:自动探测项目类型(Node/TypeScript、Python、Rust、Go、CLI 工具、库、Web 应用、测试、CI 等),从 package.json、pyproject.toml、Cargo.toml、setup.py、入口文件 docstring 等来源提取名称、描述、脚本与安装命令;按固定结构草拟 README,包含必需章节(标题、一行 tagline、功能说明、安装、用法)与按需可选章节(前置条件、配置、开发、测试、API、贡献、未来计划、许可证);遵循 GitHub 风格 Markdown 与明确写作风格(主动语态、现在时、代码块带语言提示、避免营销语言与徽章堆砌)。

使用方式:运行 /readme,或指定项目根目录 /readme path/to/project。流程为:探测项目、读取现有 README、获取“为什么”的一句话描述、询问项目特定背景、草拟并展示给用户确认、最后写入 README.md;若已存在则先备份为 README.md.bak。若无法从代码中确定安装与运行命令,会询问用户而非猜测。发现不到描述或仅为通用占位内容时,会向用户询问一句话说明,不会自行编造。

适用场景:新建或已有项目需要生成、刷新、重写或补充 README 时。

限制:不虚构功能或命令;不覆盖已有 README 而不先展示差异;对未知技术栈需用户提供安装与运行命令;可选章节仅在确有内容时加入。