skills.rest
PeteRichardson
PeteRichardsonCOMMUNITY
Explore all skills by this author →
GitHub

readme

Generates a README.md from codebase structure, manifests, and CLI definitions.

Updated Jun 4, 2026
Search Tags:#documentation#markdown#github#cli#readme#codebase analysis#generate
One-click install
npx skills add https://github.com/PeteRichardson/skills --skill readme-peterichardson
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/PeteRichardson/skills/tree/main/readme
Command: npx skills add https://github.com/PeteRichardson/skills --skill readme-peterichardson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing or updating a project README is tedious and often produces stale, placeholder-filled documentation. This Skill analyzes your actual codebase — entry points, manifests, CLI definitions, CI configs — and produces a README with real names, real commands, and real examples instead of generic boilerplate. ## Core Features & Use Cases - Codebase-driven generation: Reads Cargo.toml, package.json, CLI source (clap/argparse/cobra/click), CI workflows, and tests to extract accurate install commands, prerequisites, and usage references. - Prioritized feature checklist: Follows a must-have / nice-to-have priority table covering badges, quickstart, CLI options, configuration, known limitations, and license. - Auto-detect vs. author annotation: Marks fields needing author input with <!-- 🖊 TODO --> comments (logo, screenshots, project status) while fully auto-generating derivable sections. - Use Case: You inherit a repo with an outdated README. Invoke the Skill and it scans the code, preserves accurate sections, rewrites stale ones, and flags exactly what you still need to supply. ## Quick Start Ask the assistant to generate a README from this codebase, and it will analyze the project structure and write a complete README.md with real commands and examples.

Frequently Asked Questions about readme

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

FAQPage Schema
How do I generate a README from an existing codebase?▼

Invoke the Skill with a request like "write a README" or "/readme". It reads your project structure, manifests, CLI definitions, and CI configs, then writes a README.md with real commands and examples extracted from the code.

What information does the README generator auto-detect?▼

It auto-detects project name, prerequisites, installation steps, CLI options, badges, license, and API docs links from files like Cargo.toml, package.json, and CI workflows. Items like logos, screenshots, and project status are marked with TODO comments for the author.

Does it work with languages other than Rust?▼

Yes. It reads manifests and entry points for Rust (Cargo.toml), Python (requirements.txt), JavaScript/TypeScript (package.json), Go (go.mod), and Swift (Package.swift), adapting the README template to each ecosystem.

Will it overwrite my existing README?▼

It reads the existing README first and preserves accurate sections while revising stale ones. After writing, it reports which sections were updated versus preserved and asks for your confirmation before finalizing.

Why does the generated README contain TODO comments?▼

HTML comments like <!-- 🖊 TODO --> mark fields only the author can supply, such as logos, demo GIFs, and project status. They do not render on GitHub but make remaining work easy to find.

Related Skills

Explore More Software Engineering Skills→
NangoHQNangoHQ
1

PRPM JSON Best Practices

Enforce required fields and structure for PRPM package manifests.

Official
Basic
cat-xierluocat-xierluo
636

subtree-publish

Publishes monorepo subdirectories to standalone GitHub repositories using git subtree.

Community
Intermediate
insightriotinsightriot
1

documentation-and-adrs

Write ADRs, API docs, READMEs, and changelogs that capture architectural decision rationale.

Official
Intermediate
1Shot-Labs1Shot-Labs
1

Documentation Generator

Generate and maintain Markdown, JSDoc, and Sphinx documentation for code, APIs, and projects.

Official
Intermediate