README.md Generator
Build a README.md for your project — configure sections, add badges, and get a formatted Markdown file ready to commit
About this ToolHow it works, benefits & use casesTap to collapse
Start a project README without staring at a blank file. This builder assembles a clean README.md from a few fields and a checklist of common sections, regenerating the Markdown live as you edit. Enter a project name (the H1), an optional description, an author, and pick a license from a short list (MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, ISC, or none). It ships with seven prefilled sections — Installation, Usage, Features, API Reference, Contributing, Tests, and Credits — each with sensible starter content you can rewrite in Markdown. Toggle sections on or off, reorder your thinking by adding custom sections, and the tool auto-builds a Table of Contents linking to every enabled section. Choosing a license also drops in a shields.io badge and a License section, and an author adds an Author section. The result downloads as README.md, ready to drop at the root of your repo.
How to Use
- 1Fill in Project name (required) and, optionally, Author and a Description.
- 2Select a License from the dropdown to add a badge and a License section, or leave it as No license.
- 3Toggle the checkbox on each section to include or exclude it from the README.
- 4Edit any enabled section’s Markdown content directly in its textarea.
- 5Click Add section to append a custom section, or the trash icon to remove one.
- 6Copy the live README.md output or download it ready to commit; use Reset to start over.
Key Benefits
- Live Markdown preview that updates as you type — no Generate step
- Seven prefilled sections (Installation, Usage, Features, API, Contributing, Tests, Credits)
- Auto-generated Table of Contents linking to every enabled section
- License picker that injects a shields.io badge and a License section
- Toggle sections on/off and add fully custom sections
- Project info persists locally between visits
- Downloads as README.md, ready to drop into your repo root
Common Use Cases
- Bootstrapping a README for a brand-new open-source repository
- Standardizing README structure across several internal projects
- Adding a license badge and License section without remembering the Markdown
- Drafting Installation and Usage sections with starter code fences to fill in
- Producing a Table of Contents that stays in sync with the sections you enable
Project info
Sections
Updates live as you edit — copy or download when ready
Add a project name to start generating your README.
Was this tool helpful?
Share Your Experience
Help others discover this tool!
Related tools
- Markdown to HTMLConvert Markdown to HTML
- Badge GeneratorBuild shields.io README badges with live preview, assemble a badge row, and export Markdown, HTML, reStructuredText or AsciiDoc
- Changelog GeneratorGenerate changelog from Git commit history
- Component Name GeneratorTurn a description into ranked, kind-aware component names with a file scaffold and a name validator (casing, collisions, clarity)
- Heroku Procfile GeneratorBuild a Heroku Procfile and matching app.json — process types, env vars, addons, dyno formation — plus a Procfile parser and audit
- HTML to MarkdownConvert HTML to Markdown
It starts with seven sections: Installation, Usage, Features, API Reference, Contributing, Tests, and Credits. Installation, Usage, Features, and Contributing are enabled by default; API Reference, Tests, and Credits start disabled. Each has placeholder Markdown content you can replace, and you can add your own sections too.
Selecting a license (MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, or ISC) inserts a shields.io license badge near the top and appends a License section stating the project is licensed under that license. It does not generate the full license text — add a separate LICENSE file for that.