A good README is the first thing anyone sees before deciding whether to use your project. This tool builds a structured, GitHub-ready README.md from a few fields instead of starting from a blank file.
What Is the README Generator?
Fill in your project name, description, install command, usage example, license, and GitHub repo path, and get a complete README.md with live badges, installation and usage sections, an optional contributing guide, and a license section.
How to Use It
- Open the tool at /tools/readme-generator.
- Enter your project details and pick a license.
- Toggle badges, a contributing section, or a table of contents on or off.
- Copy or download the generated README.md.
Key Features
- Live shields.io badges pulling real license/issues/stars data from your GitHub repo.
- Optional table of contents, generated with matching anchor links.
- Standard Contributing section with a fork-and-PR workflow.
- Direct download as README.md.
When to Use This Tool
- Kickstarting documentation for a brand-new open-source project.
- Standardizing README structure across multiple repositories.
- Quickly adding working badges to an existing project’s README.
Try It Now
Open README Generator directly, or press ⌘K and type the tool name from anywhere on the site.
Part of the Generators collection on WebdevToolbox — free, browser-based developer tools with no login required.