readme-blueprint-generator

readme-blueprint-generator is a skill for Codex from appleweiping/WEIPING_WIKI. It costs 87 tokens per session (712 once invoked), scanned A, original, MIT.

A tool for creating or rewriting a project's README.md, the main introduction and usage guide in a code repository. It organizes setup instructions, project information, and links for readers and maintainers.

In plain words
What is it for?
Use it to improve onboarding, quick-start instructions, repository structure, and public GitHub documentation.
Why use it?
It helps replace unclear or disorganized repository documentation with a guide that is easier to understand and use.

Skill for Codex

Written for Codex: installed under .codex/. Also seen: mentions AGENTS.md.

Good fit Use it to improve onboarding, quick-start instructions, repository structure, and public GitHub documentation.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/appleweiping/weiping_wiki/readme-blueprint-generator
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 appleweiping/WEIPING_WIKI --skill readme-blueprint-generator
Clone the repo
git clone --depth 1 https://github.com/appleweiping/WEIPING_WIKI

Made for: 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/appleweiping/weiping_wiki/readme-blueprint-generator/github.svg)](https://agentmods.dev/skills/appleweiping/weiping_wiki/readme-blueprint-generator)
Your own site
<a href="https://agentmods.dev/skills/appleweiping/weiping_wiki/readme-blueprint-generator"><img src="https://agentmods.dev/badge/skills/appleweiping/weiping_wiki/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/appleweiping/weiping_wiki/readme-blueprint-generator"><img src="https://agentmods.dev/badge/skills/appleweiping/weiping_wiki/readme-blueprint-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 87 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 712 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found 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.00087 $0.00712
Opus 5 $0.00044 $0.00356
Sonnet 5 $0.00017 $0.00142
Haiku 4.5 $0.00009 $0.00071

Measured 7d ago against content hash 8fbc41f8c9a7, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, 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 7d 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.

.codex/skills/readme-blueprint-generator/SKILL.md · 66 lines

How it starts

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

README Blueprint Generator

Generate or rewrite README.md as the public front door to a repository. The output should feel intentionally designed: clear first impression, strong hierarchy, concrete quick start, and no filler.

Workflow

  1. Inspect the current README and the project's authoritative docs before rewriting.
    • Prefer AGENTS.md, .wiki-schema.md, purpose.md, CONTRIBUTING.md, WORKFLOWS.md, package metadata, docs indexes, and existing automation scripts when present.
    • If .github/copilot/ or .github/copilot-instructions.md exists, read the smallest relevant files for architecture, stack, tests, workflow, and standards.
  2. Decide the README's audience and job.
    • Public reader: what is this, why should they care, where do they go next?
    • Maintainer or future agent: how do they start, verify, maintain, and avoid dangerous mistakes?
  3. Build a narrative outline before editing.
    • Start with a crisp identity sentence.
    • Put the most important navigation and quick-start material above long reference sections.
    • Use tables only when they reduce cognitive load.
    • Link to deeper docs instead of duplicating them.
  4. Rewrite for polish.
    • Prefer specific verbs and nouns.
    • Remove generic "comprehensive", "powerful", "easy-to-use" language unless backed by concrete behavior.
    • Keep sections visually varied: short paragraphs, compact tables, short command blocks, and scannable bullets.
    • Avoid overlong catalogs in README; point to maintained indexes.
  5. Validate the README as an artifact.
    • Check that commands are plausible for the repo.
    • Check that public/private boundaries are respected.
    • Check that the README does not claim unverified features or live status.
    • Run the repository's documentation, lint, catalog, or diff hygiene commands when available.

Use this only as a starting shape; adapt to the repo.

  • Title and one-sentence positioning.
  • Short "why it exists" paragraph.
  • Entry map or "start here" table.
  • Quick start or common commands.
  • Architecture or repository map.
  • Core workflows.
  • Quality gates and verification.
  • Contribution or maintenance contract.
  • Security/public-private boundaries when relevant.
  • Links to deeper docs.

Read the full file on GitHub · 66 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 7d ago First seen · 66 lines · 87 tokens per session scan A 8fbc41f8c9a7

Subscribe to this mod's changes

readme-blueprint-generator is a skill published in the GitHub repository appleweiping/WEIPING_WIKI (122 stars, last pushed 15d ago), licensed MIT. It adds 87 tokens to every session and 712 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

recipe-create-meet-space

Create a Google Meet meeting space and share the join link.

googleworkspace/cli · 18 tokens

workthreads

SpecStory Workthreads - a weekly work-thread rollup across a team's repos from SpecStory coding histories (any agent - Claude Code, Codex, Cursor, Gemini, and more). It groups the window's sessions into threads of work per project and labels each new / open / recently closed, so a lead sees what shipped, what is still…

specstoryai/getspecstory · 126 tokens

atmos-config

Atmos root configuration: atmos.yaml discovery, precedence, deep merging, basepath, imports, minimal bootstrap, and routing to narrower Atmos skills.

cloudposse/atmos · 31 tokens

story-readiness

Validate that a story file is implementation-ready. Checks for embedded GDD requirements, ADR references, engine notes, clear acceptance criteria, and no open design questions. Produces READY / NEEDS WORK / BLOCKED verdict with specific gaps. Use when user says 'is this story ready', 'can I start on this story', 'is…

Donchitos/Claude-Code-Game-Studios · 77 tokens

autotask-creator

Rules for automation CRUD from the group-chat commander. The commander does not call mutation tools and does not edit cloud/autotasks files directly. It emits one or more top-level ... containers in its final text; the bus parses and applies them after the turn.

Orkas-AI/Orkas · 5 tokens

projects

List all managed projects with status, branch, open PRs, and open issue counts — portfolio-level view.

me2resh/apexyard · 24 tokens