New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Official agent skill

Readme Blueprint Generator

by github in github/awesome-copilot

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation.

OfficialMITAuto-check passedDevelopment

Install Readme Blueprint Generator

skills CLI
$ npx skills add github/awesome-copilot --skill readme-blueprint-generator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install github/awesome-copilot readme-blueprint-generator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/readme-blueprint-generator .claude/skills/readme-blueprint-generator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
readme-blueprint-generator
GitHub stars
40k
Used in
2 other repos
Token cost
~729 tokens
SKILL.md length
294 words
Files
1
Skills in repo
417
Repo updated
First seen
Licence
MIT

At a glance

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation.

  • Works in 3 steps: Scan all the files in the… → Also review the copilot-instructions.md… → Create a README.md with the following…
  • Tasks that involve Technical documentation
  • SKILL.md covers Project Name and Description, Technology Stack, Project Architecture and Getting Started, plus 7 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Readme Blueprint Generator is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. 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.

Its SKILL.md is about 730 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, Code quality and Agent instruction files. It works with GitHub. The repository describes itself as: Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve Code quality
  • Tasks that involve Agent instruction files

Example prompts

  • “/readme-blueprint-generator”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. Scan all the files in the .github/copilot folder, like
  2. Also review the copilot-instructions.md file in the .github folder
  3. Create a README.md with the following sections

What it can do on your machine

Read from SKILL.md and the folder at commit 727ff2e. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Blueprint Generator loads about 729 tokens when it runs. Until then it costs about 122 tokens; SKILL.md has 294 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~122
When it runs · the whole SKILL.md, loaded when a task matches
~729

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from github/awesome-copilot at commit 727ff2e, republished under its MIT licence (© github). 294 words, ~729 tokens.

Download SKILL.mdSave it as .claude/skills/readme-blueprint-generator/SKILL.md (or your agent's skills folder).
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:

  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:

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.

© github, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/readme-blueprint-generator of github/awesome-copilot.

Open the folder on GitHubat commit 727ff2e

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 2 other GitHub owners. This page covers the copy in github/awesome-copilot, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Readme Blueprint Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Blueprint Generator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme Blueprint Generator this skillgithub/awesome-copilot40k2 repos~729Automated safety check: PassMIT
Mariadb Operator PR Reviewmariadb-operator/mariadb-operator1k—~3.3kAutomated safety check: PassApache-2.0
Create Skill Samplepnp/copilot-prompts891—~3.1kAutomated safety check: PassMIT
Code Reviewsortie-ai/sortie196—~2.9kAutomated safety check: PassMIT
Readme Blueprint Generatorappleweiping/WEIPING_WIKI119—~880Automated safety check: PassMIT
Create Simple Promptpnp/copilot-prompts891—~2.6kAutomated safety check: PassMIT

Similar skills

  • Mariadb Operator PR Review

    mariadb-operator/mariadb-operator

    Perform a structured maintainer-style PR review for the mariadb-operator repository.

    1k GitHub stars~3.3k tokensUpdated 2 days ago
    DevelopmentAuto-check passed

  • Create Skill Sample

    pnp/copilot-prompts

    This skill should be used when the user asks to "create a new skill sample", "add a skill", "scaffold a new skill", "contribute a skill", "create a GitHub Copilot skill", "build a custom skill", or…

    891 GitHub stars~3.1k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Code Review

    sortie-ai/sortie

    Reviews pull requests in this repository for the defect classes a mechanical checklist misses: documentation that outlived the code it describes, reaction and retry state that leaks or clobbers a…

    196 GitHub stars~2.9k tokensUpdated today
    DevelopmentAuto-check passed

  • Readme Blueprint Generator

    appleweiping/WEIPING_WIKI

    Create, rewrite, or critique high-quality project README.md files.

    119 GitHub stars~880 tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

  • Create Simple Prompt

    pnp/copilot-prompts

    This skill should be used when the user asks to "create a new prompt sample", "add a new prompt sample", "scaffold a new prompt sample", "create a prompt contribution", "add a prompt", or needs to…

    891 GitHub stars~2.6k tokensUpdated yesterday
    AI & LLM EngineeringAuto-check passed

  • Workflow Creator

    nicepkg/ai-workflow

    Create complete Claude Code workflow directories with curated skills.

    285 GitHub stars~2.6k tokensUpdated 8 mo ago
    Agent WorkflowsAuto-check passed

More from github/awesome-copilot

All 417 skills in this repo

  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    Auto-check passed

  • Azure Architecture Autopilot

    github/awesome-copilot

    Official

    Designs Azure infrastructure from a natural-language description, or diagrams an existing resource group, then refines the design through conversation and deploys it with Bicep.

    40k GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed

  • Draw.io Diagram Generator

    github/awesome-copilot

    Official

    Generates, edits and validates draw.io files with correct mxGraph XML, covering flowcharts, architecture, sequence, ER and UML class diagrams.

    40k GitHub starsUsed in 1 repo~4.9k tokens
    Auto-check passed

  • Credit Risk Data Cleaning

    github/awesome-copilot

    Official

    Cleans raw credit data and screens variables before loan modeling, dropping unstable, noisy or redundant features and writing an Excel report of every step.

    40k GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed

  • Daily Focus Board

    github/awesome-copilot

    Official

    Builds a warm, browser-based daily focus board the user updates by talking to their agent, with Eisenhower priorities, a brain-dump box and kind not-today carryover.

    40k GitHub stars~3k tokensUpdated today
    Auto-check passed

  • Python Pypi Package Builder

    github/awesome-copilot

    Official

    End-to-end skill for building, testing, linting, versioning, and publishing a production-grade Python library to PyPI.

    40k GitHub starsUsed in 1 repo~4.6k tokens
    Auto-check passed

Works with

Categories

Questions about Readme Blueprint Generator

What does Readme Blueprint Generator do?

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Readme Blueprint Generator is an agent skill from github/awesome-copilot, published by the product's own GitHub organization.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation.

When should I use Readme Blueprint Generator?

Readme Blueprint Generator fits situations like: tasks that involve Technical documentation; tasks that involve Code quality; tasks that involve Agent instruction files.

How do I install Readme Blueprint Generator in Claude Code?

Run `npx skills add github/awesome-copilot --skill readme-blueprint-generator -a claude-code`. Or copy the skill folder (skills/readme-blueprint-generator in github/awesome-copilot) into .claude/skills/readme-blueprint-generator in your project. Claude Code loads it when a task matches its description.

How do I install Readme Blueprint Generator in Codex?

Run `npx skills add github/awesome-copilot --skill readme-blueprint-generator -a codex`. Or copy the skill folder (skills/readme-blueprint-generator in github/awesome-copilot) into .agents/skills/readme-blueprint-generator in your project. Codex loads it when a task matches its description.

Can I use Readme Blueprint Generator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add github/awesome-copilot --skill readme-blueprint-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-blueprint-generator, .gemini/skills/readme-blueprint-generator, .github/skills/readme-blueprint-generator and .opencode/skills/readme-blueprint-generator in your project.

What does Readme Blueprint Generator need to run?

SKILL.md names no scripts, command-line tools or credentials: Readme Blueprint Generator is instructions for the agent only.

Does Readme Blueprint Generator access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme Blueprint Generator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme Blueprint Generator use?

Readme Blueprint Generator is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Readme Blueprint Generator use?

About 729 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme Blueprint Generator?

Skills that share tags, products or a category with Readme Blueprint Generator: Mariadb Operator PR Review (mariadb-operator/mariadb-operator, 1k stars), Create Skill Sample (pnp/copilot-prompts, 891 stars), Code Review (sortie-ai/sortie, 196 stars) and Readme Blueprint Generator (appleweiping/WEIPING_WIKI, 119 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Blueprint Generator?

github (a GitHub organization, an official publisher) maintains it in github/awesome-copilot, which has 39,748 GitHub stars. The repository holds 417 skills in this directory. The repository was last updated on October 7, 2026.

Source: github/awesome-copilot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.