readme-blueprint-generator

readme-blueprint-generator is a skill for Claude Code, Codex from OKHP3/skillz. It costs 76 tokens per session (566 once invoked), scanned A, a copy of readme-blueprint-generator, MIT.

A prompt for creating a README.md by examining a repository's project instructions and documentation. A README is the main guide that explains what a project is, how it is built, and how to work with it.

In plain words
What is it for?
Use it to draft or refresh a repository README from files describing its structure, technology stack, development process, and testing practices.
Why use it?
It turns scattered project notes into a single starting point for contributors. It helps document the technology, architecture, setup, workflow, coding rules, and tests.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to draft or refresh a repository README from files describing its structure, technology stack, development process, and testing practices.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/okhp3/skillz/readme-blueprint-generator
View source ↗ OKHP3/skillz
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add OKHP3/skillz --skill readme-blueprint-generator
Clone the repo
git clone --depth 1 https://github.com/OKHP3/skillz

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-blueprint-generator

README.md
[![agentmods](https://agentmods.dev/badge/skills/okhp3/skillz/readme-blueprint-generator/github.svg)](https://agentmods.dev/skills/okhp3/skillz/readme-blueprint-generator)
Your own site
<a href="https://agentmods.dev/skills/okhp3/skillz/readme-blueprint-generator"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/readme-blueprint-generator/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-blueprint-generator

Your own site · 80×15
<a href="https://agentmods.dev/skills/okhp3/skillz/readme-blueprint-generator"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/readme-blueprint-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 76 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 566 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00076 $0.00566
Opus 5 $0.00038 $0.00283
Sonnet 5 $0.00015 $0.00113
Haiku 4.5 $0.00008 $0.00057

Measured 5d ago against content hash 571094038e74, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

readme-blueprint-generator scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to readme-blueprint-generator — 1 line differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

community/readme-blueprint-generator/SKILL.md · 79 lines

How it starts

The opening of the file, as written. The whole thing — 79 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

Read the full file on GitHub · 79 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 79 lines · 76 tokens per session scan A 571094038e74

Subscribe to this mod's changes

readme-blueprint-generator is a skill published in the GitHub repository OKHP3/skillz (3 stars, last pushed today), licensed MIT. It adds 76 tokens to every session and 566 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to readme-blueprint-generator, differing in 1 line, and is treated as a copy.

Related

Other skills, from other repositories

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens

baoyu-url-to-markdown

Fetch any URL and convert to markdown using baoyu-fetch CLI (Chrome CDP with site-specific adapters). Built-in adapters for X/Twitter, YouTube transcripts, Hacker News threads, and generic pages via Defuddle. Handles login/CAPTCHA via interaction wait modes. Use when user wants to save a webpage as markdown.

JimLiu/baoyu-skills · 72 tokens

pm-preview

A tool that previews Markdown product documents in a web browser and refreshes the view when the documents change. Markdown is a plain-text format commonly used for project documentation.

konglong87/superPM · 77 tokens

obsidian-skills-integrated

A skill for writing and editing Obsidian notes while preserving Obsidian-specific formats. Obsidian is a note-taking app that supports links between notes, callouts, databases, and visual canvases.

anbeime/skill · 74 tokens

obsidian-markdown

A Markdown writing workflow for Obsidian, a note-taking app that can link notes together. It supports features such as two-way links, callouts, frontmatter, embedded content, and wikilinks.

anbeime/skill · 73 tokens

pptx-generator

A tool that converts JSON data, a structured text format often used by software, into standard .pptx presentation files. It applies layouts and can format charts and tables.

anbeime/skill · 69 tokens