用途:为本地项目或 GitHub 项目生成专业 README.md 文档,触发词包括“写 README”“生成 README”“README.md”“项目文档”“GitHub 文档”“项目介绍”“文档生成”等。
主要能力:采用交互式流程(自动收集信息→用户确认→生成目录→确认→生成 README→迭代优化)。可读取 package.json、requirements.txt、pyproject.toml、Cargo.toml 及主语言文件、目录结构、现有 README;支持中英双语、双语独立目录、Badge 区域生成、可选章节(致谢/贡献/更新日志)、质量检查、备份与多轮迭代,并按 Python、前端、API、CLI、库/SDK、OpenClaw Skill 等类型组织特有章节。
使用方式:对 AI 说出触发词并给出本地路径或 GitHub URL,如“为这个项目写 README:~/.openclaw/skills/my-project”或“给 https://github.com/user/repo 写 README”。可用 --lang bilingual/chinese/english、--detail minimal/standard/complete、--style professional/friendly/complete 等参数调整。
适用场景:本地项目、GitHub 项目、Skill 项目、优化现有 README,或参考指定风格重写。
限制:不用于代码审查、项目部署或问题排查;致谢等章节须先询问;扩展参数、安装命令及具体收费与平台支持资料未完整提供,暂未确认。