SuperAPI AI 工具集

readme-generator

通用与其它

查看项目

更新于 10-15 22:19

技能介绍

用途:分析项目真实文件,生成反映项目实际功能的 README.md,避免套话式模板。

主要能力:先收集项目上下文,优先读取 package.json、pyproject.toml、Cargo.toml、go.mod、composer.json 等清单文件,以及 index.js、main.py、app.py、src/index.、cmd/main.go 等入口文件;其次读取 .env.example、Makefile、Dockerfile、docker-compose.yml、CONTRIBUTING.md、LICENSE、CHANGELOG.md,并查看 src/ 或 lib/ 前两层结构。可用命令列出结构:find . -maxdepth 3 -not -path '/node_modules/' -not -path '/.git/' -not -path '/pycache/' -not -path '/dist/' -not -path '/build/*' | sort | head -80。随后推断项目用途、目标用户、技术栈、运行方式与环境变量。

使用方式:按固定章节结构撰写,包括项目名、一句话标语、简介、Features、Requirements、Installation、Configuration、Usage、Project Structure、API Reference、Development、Contributing、License;不适用的章节跳过,不添加空标题。命令一律用代码块,配置用表格。最终将 README.md 写入项目根目录(容器中为 /mnt/user-data/outputs/README.md),并调用 present_files 供下载。

限制与注意:不得臆造,找不到安装命令时写 # TODO: add install command;不确定的章节加 <!-- TODO: verify --> 注释。若已有 README,先阅读再改进而非替换准确内容。无清单文件时按扩展名推断并注明不确定;monorepo 先写根再列各包;私有工具省略徽章。资料未提供具体收费、平台或效果信息。