Docs 67 installs

readme-blueprint-generator

by github/awesome-copilot

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot…

Skill content

Automated README generation by analyzing project documentation structure and metadata files.

- Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, and development workflow

- Generates well-structured markdown with standard sections: overview, tech stack, architecture, setup, folder structure, features, development workflow, coding standards, testing, and contributing guidelines

- Produces developer-focused documentation with proper formatting, cross-references, and code blocks for clarity

- Extracts and organizes information from multiple source files including Architecture, Coding_Standards, Technology_Stack, Unit_Tests, and Workflow_Analysis documents

README Generator Prompt

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:

-

Scan all the files in the .github/copilot folder, like:

- Architecture

- Code_Exemplars

- Coding_Standards

- Project_Folder_Structure

- Technology_Stack

- Unit_Tests

- Workflow_Analysis

-

Also review the copilot-instructions.md file in the .github folder

-

Create a README.md with the following sections: