🚀 快速安装

复制以下命令并运行，立即安装此 Skill：

npx @anthropic-ai/skills install github/awesome-copilot/readme-blueprint-generator

💡 提示：需要 Node.js 和 NPM

README 生成器提示词

通过分析 .github/copilot 目录中的文档文件和 copilot-instructions.md 文件，为此仓库生成一个全面的 README.md。请遵循以下步骤：

  1. 扫描 .github/copilot 文件夹中的所有文件，例如：
    • Architecture（架构）
    • Code_Exemplars（代码示例）
    • Coding_Standards（编码标准）
    • Project_Folder_Structure（项目文件夹结构）
    • Technology_Stack（技术栈）
    • Unit_Tests（单元测试）
    • Workflow_Analysis（工作流分析）
  2. 同时审查 .github 文件夹中的 copilot-instructions.md 文件
  3. 创建一个包含以下部分的 README.md：

项目名称与描述

  • 从文档中提取项目名称和主要用途
  • 包含对项目功能的简洁描述

技术栈

  • 列出使用的主要技术、语言和框架
  • 在可用时包含版本信息
  • 主要从 Technology_Stack 文件中获取此信息

项目架构

  • 提供架构的高级概述
  • 如果文档中有描述，可考虑包含一个简单的图表
  • 从 Architecture 文件中获取信息

快速开始

  • 根据技术栈包含安装说明
  • 添加设置和配置步骤
  • 包含任何先决条件

项目结构

  • 简要概述文件夹组织
  • 从 Project_Folder_Structure 文件中获取信息

主要功能

  • 列出项目的主要功能
  • 从各种文档文件中提取

开发工作流程

  • 总结开发流程
  • 如果可用，包含有关分支策略的信息
  • 从 Workflow_Analysis 文件中获取信息

编码标准

  • 总结关键的编码标准和约定
  • 从 Coding_Standards 文件中获取信息

测试

  • 解释测试方法和工具
  • 从 Unit_Tests 文件中获取信息

贡献指南

  • 为项目做出贡献的指南
  • 参考任何代码示例以获得指导
  • 从 Code_Exemplars 和 copilot-instructions 文件中获取信息

许可证

  • 如果可用，包含许可证信息

使用正确的 Markdown 格式化 README，包括：

  • 清晰的标题和副标题
  • 在适当的地方使用代码块
  • 使用列表以提高可读性
  • 链接到其他文档文件
  • 如果信息可用，添加构建状态、版本等徽章

保持 README 简洁但信息丰富，重点关注新开发者或用户需要了解的项目相关信息。

📄 原始文档

完整文档（英文）：

https://skills.sh/github/awesome-copilot/readme-blueprint-generator

💡 提示：点击上方链接查看 skills.sh 原始英文文档，方便对照翻译。

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。