用途:为项目生成或重构以真实代码库为依据的 README.md,避免样板化内容;适用于根目录或 monorepo 子包的 README。\n\n主要能力:先扫描项目结构并判断形态(CLI、库、Web 应用、monorepo、插件、框架、文档站、服务),再读取现有 README、AGENTS.md、CLAUDE.md、许可证、清单文件和入口点,据此选择章节、顺序和深度。每条安装命令、脚本、徽章和示例都要能追溯到仓库中的真实文件。支持 create(无 README)、refactor(陈旧或与代码矛盾)、update(局部章节)三种模式。\n\n使用方式:以“仔细阅读项目并创建 README”“重构 README 使其匹配当前 CLI 命令”“为 monorepo 的 packages/color 生成 README”等请求触发。默认面向用户交付物使用韩语,保留源码标识符、CLI 命令、文件路径、schema 键、包名等原文;仅当用户明确要求或需保持既有语言一致时才换语言。\n\n适用场景:README 生成与重构、monorepo 子包 README、安装与用法章节更新。\n\n限制:不写 CHANGELOG、CONTRIBUTING、LICENSE 等其他文件;不做源代码修改或功能实现;不进行无 README 产物的外部研究。仅使用项目内的读写与搜索工具,不运行安装、构建、部署、发布命令。无法从仓库验证的命令、环境变量或 API 不得编造,未知项用 <!-- TODO --> 标记。单次请求只跑一遍流程。项目形态不明确、许可证不清或命令无法验证时应升级确认。
readme-maker
编程与开发
更新于 10-15 16:48