README / .md file generator
Fill in the form to build a README for your project. Switch to the Preview tab to see it rendered, then download as README.md or copy the markdown.
How it works
What sections are included?
The generator creates a README with: project title, description, Installation section (wrapped in a bash code block), Usage section (wrapped in a code block), License section, and optional shields.io badges at the top. Only sections you fill in are included — empty fields are omitted.
How do I add badges?
Visit shields.io, configure your badge, copy the markdown snippet (starts with [![), and paste it into the Badges field. You can paste multiple badges on separate lines.
Can I customise the output further?
Download the file and open it in any text editor to add, remove, or reorder sections. The generated file is plain text — no special encoding or lock-in.
Is anything stored or sent?
No. The form data lives only in your browser tab. Nothing is saved to a server or sent over the network.