readme-blueprint-generator

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 简洁但信息丰富，重点关注新开发者或用户需要了解的项目信息。