README Generator
FreeGenerate a well-structured README.md for your project, instantly.
Runs entirely in your browser. Nothing you enter is uploaded or stored.
Auto-generated from every other enabled section's heading, in order.
Enable a section to see the preview…
How it works
What makes a good README?
A clear one-line description of what the project does, straightforward installation steps, a working usage example, and — for anything accepting outside contributions — a short contributing guide. Badges and a table of contents help at a glance, but the description and usage example are what actually get someone from "found this repo" to "got it running."
How do the generated sections map to common conventions?
Each toggleable section mirrors a convention seen across most real-world READMEs: badges (shields.io-style build/version/license/package badges), a table of contents auto-linked to the headings you have enabled, features as a bullet list, a configuration table for environment variables, and separate installation/usage/contributing/license sections. Reordering or disabling any of them updates the generated Markdown — and the table of contents — immediately.
Can I start from a template instead of a blank form?
Yes — three starting templates (Minimal, Open Source Project, Internal Tool) pre-fill a sensible subset of sections with placeholder content, which you can then edit, reorder, or turn sections on and off from there.
Does this tool store or upload anything I enter?
No. Everything — every section's content and the live preview — is generated entirely in your browser. Nothing is sent to a server, logged, or saved.