Back to Details

readme-blueprint-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

README Generator Prompt

README生成器提示词

Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:
  1. Scan all the files in the .github/copilot folder, like:
    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis
  2. Also review the copilot-instructions.md file in the .github folder
  3. Create a README.md with the following sections:
通过分析.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：

Project Name and Description

项目名称与描述

  • Extract the project name and primary purpose from the documentation
  • Include a concise description of what the project does
  • 从文档中提取项目名称和核心用途
  • 简要描述项目的功能

Technology Stack

技术栈

  • List the primary technologies, languages, and frameworks used
  • Include version information when available
  • Source this information primarily from the Technology_Stack file
  • 列出使用的主要技术、语言和框架
  • 如有可用版本信息，请一并包含
  • 主要从Technology_Stack文件中获取信息

Project Architecture

项目架构

  • Provide a high-level overview of the architecture
  • Consider including a simple diagram if described in the documentation
  • Source from the Architecture file
  • 提供架构的高层概述
  • 如果文档中有描述，可考虑添加简单示意图
  • 从Architecture文件中获取信息

Getting Started

快速开始

  • Include installation instructions based on the technology stack
  • Add setup and configuration steps
  • Include any prerequisites
  • 根据技术栈包含安装说明
  • 添加设置和配置步骤
  • 列出所有前置要求

Project Structure

项目结构

  • Brief overview of the folder organization
  • Source from Project_Folder_Structure file
  • 简要概述文件夹组织方式
  • 从Project_Folder_Structure文件中获取信息

Key Features

核心功能

  • List main functionality and features of the project
  • Extract from various documentation files
  • 列出项目的主要功能特性
  • 从各类文档文件中提取信息

Development Workflow

开发工作流

  • Summarize the development process
  • Include information about branching strategy if available
  • Source from Workflow_Analysis file
  • 总结开发流程
  • 如果有分支策略相关信息，请一并包含
  • 从Workflow_Analysis文件中获取信息

Coding Standards

编码规范

  • Summarize key coding standards and conventions
  • Source from the Coding_Standards file
  • 总结关键编码标准和约定
  • 从Coding_Standards文件中获取信息

Testing

测试

  • Explain testing approach and tools
  • Source from Unit_Tests file
  • 说明测试方法和使用的工具
  • 从Unit_Tests文件中获取信息

Contributing

贡献指南

  • Guidelines for contributing to the project
  • Reference any code exemplars for guidance
  • Source from Code_Exemplars and copilot-instructions
  • 项目贡献的指导方针
  • 参考代码示例获取指导
  • 从Code_Exemplars和copilot-instructions中获取信息

License

许可证

  • Include license information if available
Format the README with proper Markdown, including:
  • Clear headings and subheadings
  • Code blocks where appropriate
  • Lists for better readability
  • Links to other documentation files
  • Badges for build status, version, etc. if information is available
Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.
  • 如有可用，请包含许可证信息
使用规范的Markdown格式编写README，包括：
  • 清晰的标题和子标题
  • 适当位置使用代码块
  • 使用列表提升可读性
  • 链接到其他文档文件
  • 如有可用信息，添加构建状态、版本等徽章
保持README简洁且信息丰富，重点关注新开发者或用户需要了解的项目相关内容。