README Generator - Free GitHub README.md Builder

What is it?

A README generator is a form-based tool that writes the README.md file for a code repository, so you fill in fields instead of hand-writing Markdown. This one has 19 sections you can switch on and reorder, 24 shields.io badge presets and a live GitHub-style preview, and it runs entirely in your browser.

How to use

Pick a starting point from Templates: Minimal, Standard or Full
Switch sections on or off and fill in their fields; use the up/down arrows to change the order
Add badges with Quick Add and pick a Badge Style; the style applies to every badge
Check the result in the Preview tab, or the raw Markdown in the Markdown Code tab
Press Copy Markdown, or Download README.md to save the file

Frequently asked questions

Is my project information sent to a server?

No. The Markdown is generated by JavaScript in your browser and nothing you type is sent to a server; your draft is kept only in this browser's local storage. The preview does load the badge and image URLs you add (for example from img.shields.io) directly from those hosts.

How do I reorder sections in my README?

Use the up and down arrows to the left of each enabled section's name. The preview and the Markdown follow the new order straight away.

How do I add badges to a GitHub README?

Turn on the Badges section, click any Quick Add preset and pick a Badge Style. Each badge is inserted as a shields.io image in Markdown; replace placeholders such as USERNAME/REPO or PACKAGE_NAME with your own.

Can I change the badge style after adding badges?

Yes. Badge Style is one setting for the whole Badges section, so switching it restyles every badge at once, including ones you added earlier.

Does it create a table of contents automatically?

Yes. Turn on Table of Contents and it lists every enabled section that has content, with anchor links that work on GitHub.

Can I add my own section?

Yes. Enable Custom Sections and add as many title and content pairs as you need; each becomes its own ## heading and appears in the table of contents.

Is my work saved if I refresh the page?

Yes, in this browser. The form is saved to local storage as you type and restored when you reload or come back. It isn't synced to other devices, and Reset all deletes the saved draft.

Is the README generator free?

Yes. It is free with no sign-up, and the README.md you download is yours to use in any project.

Features

19 sections: Title, Badges, Table of Contents, Tech Stack, Features, Demo, Screenshots, Installation, Environment Variables, Run Locally, Usage, Running Tests, API Reference, Roadmap, FAQ, Contributing, License, Acknowledgements and Custom Sections, each with an on/off switch.
Reorder with arrows: Each enabled section has up and down arrows that move it one place in the output.
Badge builder: 24 shields.io presets (licenses, languages, frameworks, databases, GitHub stars/forks/issues) with an editable label and URL. One Badge Style (Flat, Flat Square, Plastic, For the Badge or Social) applies to every badge.
Tech stack picker: Search and select from 59 technologies, from React and Next.js to PostgreSQL, Docker and Playwright; the choices become a bulleted Tech Stack list.
Table of Contents: Builds a linked list of every enabled section that has content, in the current order.
Structured sections: Installation, Usage, Run Locally and Running Tests are wrapped in ```bash fences, Environment Variables become a Variable / Description / Required table, Roadmap items become task-list checkboxes, and License offers 9 options including MIT, Apache 2.0 and GPL 3.0.
Draft autosave: Your form is saved in this browser's local storage half a second after each change and restored when you come back. Reset all clears it.
3 templates: Minimal turns on title, installation, usage and license; Standard adds badges, contents, tech stack, features and contributing; Full enables everything except custom sections.