Prompt · Slash command

README Generator

Generate a professional README from your project structure and code.

What happens when you install it

You run the install command

mcp install-skill readme-generator

MCPHub CLI downloads this prompt from the registry.

Saved as a file in Claude Code

~/.claude/commands/readme-generator.md

Claude Code reads all .md files in this folder as slash commands.

Use it in any conversation

/readme-generatorin Claude Code (after restart)

Claude runs the prompt against your current file or selection — no copy-paste needed.

Content

README Generator

Generate a professional README.md for the project based on its code, structure, and purpose.

Structure to follow

# Project Name
> One-line description — what it does, for whom

## Why
The problem it solves. Not what it is — why it exists.

## Quick start
Minimal install + first working example. Copy-pasteable.

## Usage
Core use cases with real code. Cover the 80% case.

## Configuration
Key options, environment variables, config file format.

## Contributing
How to run locally, run tests, submit a PR. Keep it short.

## License