Markdown Tools
README Generator
Build a complete README.md from a form.
Loading tool…
What is README?
A form-based README builder that assembles a complete, well-structured README.md from your project's details.
How it works
Each form section maps to a README section (intro, install, usage, badges, license, contributing) and is stitched together into a Markdown document.
- Enter your input. Type or paste your input into the field above — the tool responds instantly.
- Review the result. Output updates live as you type. Everything runs entirely in your browser.
- Copy or download. Use the Copy button to grab the result, or Download to save it as a file.
Examples
Scaffolding a README
Generate a README skeleton from your project name, description, and license — install, usage, and contribution sections included.
Common mistakes
Placeholder sections
The generator scaffolds structure — replace the placeholder content with real instructions before publishing.
Frequently asked questions
What sections are generated?
Title, badges, description, install, usage, contributing, license, and a shields badge if you opt in.
Does it generate a license file?
It includes the license section text and badge; the full license file is up to you.