readme-generator

Generate structured Skill metadata from repository evidence and SKILL.md frontmatter.

29|5|Updated Mar 13, 2026
One-click install
npx skills add https://github.com/johnqtcg/awesome-skills --skill readme-generator-johnqtcg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-generator
Source: https://github.com/johnqtcg/awesome-skills/tree/main/skills/readme-generator
Command: npx skills add https://github.com/johnqtcg/awesome-skills --skill readme-generator-johnqtcg

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Generate, validate, and maintain structured metadata for a Skill unit using repository evidence.

Core Features & Use Cases

  • Generate high-quality README documents from codebase evidence, with commands, structure, and maintenance rules.
  • Refactor and standardize existing READMEs based on real repo signals and templates for services, libraries, CLIs, monorepos, and lightweight tools.
  • Provide an evidence-mapped output with a governance and verification framework, including Badges, Evidence Mapping, and Update Triggers.

Quick Start

Input the repository evidence and desired skill type; the generator outputs a ready-to-paste, evidence-backed README skeleton.

Frequently Asked Questions about readme-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README from repository evidence automatically?

You can generate a README from repository evidence by providing repo context and skill type. The generator extracts fields like name, tagline, and dependencies from SKILL.md frontmatter to output a ready-to-paste, evidence-backed README skeleton.

What is evidence mapping for documentation and when do I need it?

Evidence mapping for documentation links README fields directly to repository signals. You need it when standardizing metadata for services, libraries, or CLIs to ensure structure, governance, and verification through explicit update triggers.

How do I standardize existing READMEs for a monorepo with multiple skill units?

Standardize existing READMEs for a monorepo by applying the generator to refactor documents based on real repo signals. It validates structured metadata across multiple skill units using templates for lightweight internal tools and libraries.

Does the README generator work with SKILL.md frontmatter for libraries and CLIs?

Yes, the README generator works with SKILL.md frontmatter for libraries and CLIs. It populates structured metadata fields including complexity, category, keywords, and components directly from the extracted frontmatter context.

What's the best way to maintain structured metadata and trigger README updates?

The best way to maintain structured metadata and trigger README updates is using the generator's governance framework. It establishes explicit gates and update triggers that validate fields against repository evidence to keep documentation synchronized.

When should I not use automated templates for documentation generation?

Avoid automated templates for documentation generation when a project lacks underlying repository evidence or SKILL.md frontmatter. The generator requires explicit repo context and signals to populate fields and map evidence accurately.