readme-blueprint-generator
- Use it when:
- Your repo already has Copilot docs in .github/copilot and a copilot-instructions.md, and you want a README built from them.
- It does:
- Reads those files and writes 11 README sections, most drawn from the matching doc.
- You get:
- A README.md with headings, code blocks, links to the other docs, and badges where that information exists.
- Unlike create-readme:
- That one, from the same repo, reviews the whole project; this one draws on docs that already describe it.
- Needs:
- Those docs first: files such as Architecture, Technology_Stack, Coding_Standards, Unit_Tests and Workflow_Analysis.
Works from documentation files you must already have in .github/copilot, such as Architecture, Technology_Stack and Coding_Standards, plus .github/copilot-instructions.md.
TL;DR
A one-shot README generator for repositories documented for GitHub Copilot. It scans the files in .github/copilot, named Architecture, Code_Exemplars, Coding_Standards, Project_Folder_Structure, Technology_Stack, Unit_Tests and Workflow_Analysis, plus .github/copilot-instructions.md. From them it writes a README.md with the project's name and purpose, its technology stack with versions, an architecture overview with a simple diagram if the docs describe one, getting-started steps, the folder structure, key features, the development workflow and branching strategy, coding standards, the testing approach, contributing guidelines that point to the code exemplars, and the license if known. It aims to be concise yet informative for new developers and users.
Summarizes the skill at 797337f.
npx skills add https://github.com/github/awesome-copilot --skill readme-blueprint-generator skills.sh pageSource on GitHubAll skills from github/awesome-copilot
- Total Downloads
- 9,700 on skills.sh, Nov 9, 2026
- Repo stars
- 40,943 github/awesome-copilot
- First seen
- Feb 25, 2026 on skills.sh
Weekly values
| Week to | Installs |
|---|---|
| Sep 21 | 24 |
| Sep 28 | 30 |
| Oct 5 | 26 |
| Oct 12 | 19 |
| Oct 19 | 25 |
| Oct 26 | 26 |
| Nov 2 | 23 |
| Nov 9 | 35 |
| Category |
Articles, docs, internal comms, research write-ups and prose that doesn't read as generated. |
|---|---|
| Type |
A one-shot action you invoke by name, such as turning the conversation into a PRD. |
| Effect |
Its own steps create or change files, git state or local tools. |
| Needs |
Instructions only. Works in any agent that supports skills. |
| Publisher |
A verified publisher on skills.sh, or the company or maintainer behind the product the skill operates. |
| Topics | |
| Stack |
SKILL.md
From github/awesome-copilot at 797337f. Checked daily, last changed Nov 6, 2026.
Frontmatter
name: readme-blueprint-generator
description: 'Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.'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:
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
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
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
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
Coding Standards
- Summarize key coding standards and conventions
- Source from the Coding_Standards file
Testing
- Explain testing approach and tools
- Source from Unit_Tests file
Contributing
- Guidelines for contributing to the project
- Reference any code exemplars for guidance
- Source from Code_Exemplars and 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.