用途:为项目提供 README.md 模板与标准(版本 v2025.1),用于生成或改进 README、检查 README 合规性,或在涉及 README 最佳实践时参考。
主要能力:提供三种模板风格。Minimal 适合库、小型工具、内部工具,含标题、描述、许可证徽章、安装与基本用法示例。Standard(推荐)适合大多数项目,含居中 Logo/emoji、3 个以上徽章、Features、技术栈表格、前置条件、开发命令、项目结构、贡献说明。Detailed 适合开源、文档密集型项目与开发者工具,在 Standard 基础上增加 Mermaid 架构图、API 参考、配置选项、变更日志链接、安全策略与行为准则。另附徽章参考(仓库状态、CI/CD、包注册表、技术栈)、Logo 规范(PNG/SVG、128–512px、assets/logo.png)、章节写作指南(Features 写收益而非实现)、项目类型模板(CLI 工具、库/包、Web 应用)及三档合规清单。
使用方式:资料未提供具体安装命令或调用步骤;仅提及 /configure:readme 命令用于更新现有项目、为已有代码生成 README、检查现有 README 合规性,以及可选配合 cookiecutter 从模板创建整个新项目(pip install cookiecutter,或 uv tool install cookiecutter;cookiecutter https://github.com/your-org/project-template)。
限制:具体触发方式、运行环境与配置项暂未提供。资料中的命令、徽章 URL 与代码示例应保持原样,不应改写。