README Generator
Fill in a simple form — project name, description, installation, usage, badges — and get a polished README.md with a live Markdown preview.
Your data is processed locally in your browser
How to Use the README Generator
- 1Fill in project details: name, description, installation and usage.
- 2Toggle optional sections like badges, API docs or contributing guidelines.
- 3Copy the Markdown or download README.md.
Frequently Asked Questions
Can I add GitHub badges?+
Yes, common shields.io badges (build, license, version) can be inserted with one click.
Does it generate a table of contents?+
Yes, based on the sections you fill in.
Related Tools
Popular
.gitignore Generator
Generate a combined .gitignore for any stack in seconds.
Generators
SEO Meta Tag Generator
Generate title, description, Open Graph and Twitter meta tags with live previews.
Generators
Docker Compose Generator
Visually configure services, ports and volumes to generate docker-compose.yml.
Development