---

name: readme-generator description: | Generates professional README.md files for software projects. This skill should be used when users want to create, update, or improve README documentation for any project type (CLI, library, web app, API).

README Generator

Generate professional README files adapted to project type and conventions.

What This Skill Does

• Analyzes project structure to extract key information
• Generates README with appropriate sections for project type
• Follows markdown best practices and GitHub conventions
• Adapts to existing codebase patterns

What This Skill Does NOT Do

• Generate API documentation (use dedicated API doc tools)
• Create full documentation sites (use Sphinx, MkDocs, etc.)
• Manage documentation versions

---

Before Implementation

---

Required Clarifications

Before generating, clarify:

---

Generation Workflow

Copy1. Analyze → 2. Clarify → 3. Generate → 4. Review

1. Analyze Project

Examine:

• Package config (package.json, pyproject.toml, Cargo.toml)
• Entry points (main.py, index.js, src/lib.rs)
• Existing README (if updating)
• Test files (for usage examples)

2. Clarify Requirements

Ask only what cannot be inferred from codebase.

3. Generate README

Select sections based on project type (see references/section-patterns.md).

4. Review Checklist

Before delivery:

• Title matches project name
• Description is one clear sentence
• Installation steps tested/accurate
• Usage examples are runnable
• No credentials or secrets exposed
• Links are valid

---

Output Specification

---

Reference Files