README Generator

DocumentationBeginner

Analyzes project code, config files, and directory structure to generate a complete README.md with installation instructions, usage guide, and contribution guidelines.

Trigger/readme

FrequencyProject start

Developer preparing a first open source contribution? Run /readme to quickly produce a professional-grade README

Launching a side project? Make a strong first impression with a clean README

READMEDocumentationOpen SourceOnboarding

How It Works

Run /readme -> analyze project

↓

Phase 1: 4 section generation tasks in parallel

overview-gen

Project overview

install-gen

Installation guide

usage-gen

Usage examples

contrib-gen

Contribution guide

↓

Combine markdown + add badges

↓

✓ Complete README.md

Skill Code

# README Builder Skill
## Trigger: /readme

When invoked:

1. Analyze project:
 - Package name, description, license
 - Tech stack and dependencies
 - Available scripts (build, test, lint)
 - Project structure

2. Generate README.md:
---
# Project Name

[1-line description]

[badges: build, coverage, license, version]

## Features
- ✨ [feature 1]
- 🚀 [feature 2]

## Quick Start

\`\`\`bash
# Install
[install command]

# Run
[run command]
\`\`\`

## Usage
[code example with explanation]

## Project Structure
\`\`\`
src/
├── [dir] — [description]
└── [dir] — [description]
\`\`\`

## Contributing
[contribution guide]

## License
[detected license]
---

Copy and paste into your CLAUDE.md to start using immediately.

How README Generator Works

README Builder analyzes your project's file structure, package.json, and existing documentation to generate a comprehensive README.md with installation instructions, usage examples, API reference, and contribution guidelines.

When to Use README Generator

Essential when open-sourcing a project or onboarding new team members — it creates a professional README that covers everything a newcomer needs to understand, install, and start contributing to your project.

Key Strengths

Analyzes actual project structure for accurate content
Generates installation, usage, and contribution sections
Includes badge suggestions and table of contents
Professional quality suitable for open-source projects

Same Category

Documentation View All

API Design Assistant

Designs RESTful APIs and auto-generates docs and type definitions.

Auto Doc Generator

Analyzes code and auto-generates API docs and usage guides.

Git History Analyzer

Extracts project insights and contribution patterns from Git history.

Popular in Other Categories

Session Summary

WorkflowAutomatically summarizes changes and next steps at the end of a work session.

Smart Commit

CodingAnalyzes changes and auto-generates meaningful commit messages.

CLAUDE.md Builder

ProductivityAnalyzes your project and auto-generates an optimized CLAUDE.md.