SkillsAdd

github/awesome-copilot · Official

readme-blueprint-generator

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.

All-time #1567 Trending #8542 First seen Feb 25, 2026
8-week activity · all time api

Installation

$ npx skills add github/awesome-copilot --skill readme-blueprint-generator
View on skills.sh ↗ GitHub repository ↗

Summary

  • 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

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

agent-browser Shared topics
vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs
azure-aigateway Shared topics
microsoft/azure-skills

Configure Azure API Management as an AI Gateway for AI models, MCP tools, and agents. WHEN: sem…

566.3K installs
azure-compute Shared topics
microsoft/azure-skills

Azure VM/VMSS router. WHEN: create / provision / deploy / spin-up VM, recommend VM size, compar…

510K installs
supabase-postgres-best-practices Shared topics
supabase/agent-skills

Postgres best practices maintained by Supabase, for Postgres running anywhere. Load this skill …

391.6K installs
prisma-cli Shared topics
prisma/skills

Prisma ORM CLI commands reference covering init, generate, migrate, db, dev, complete, studio, …

267K installs
supabase Shared topics
supabase/agent-skills

Use when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge F…

263K installs

Also in this package

Other skills from github/awesome-copilot · top by installs.

npx skills add github/awesome-copilot
git-commit 44.5K excalidraw-diagram-generator 29.1K documentation-writer 26.2K multi-stage-dockerfile 23.4K prd 22.9K gh-cli 21.9K refactor 21.6K java-springboot 19.9K create-readme 18.1K playwright-generate-test 18K

Browse all from github/awesome-copilot

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 38.8K
License LICENSE
Default branch main
Open issues 21
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Declared agents github-copilot

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,914 B
  • docs SUMMARY.md 493 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 9,605 installs

SKILL.md

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:

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

- Architecture - CodeExemplars - CodingStandards - ProjectFolderStructure - TechnologyStack - UnitTests - Workflow_Analysis

  1. Also review the copilot-instructions.md file in the .github folder
  1. 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 ProjectFolderStructure 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.