README Generator
Fill in a project name, description, install command and license, and this page builds a README.md you can copy.
Runs in your browser. Nothing you enter is uploaded.
Worked examples
Empty form (the placeholders are not filled in)
| Project name left blank | The heading becomes "# Project Name". |
|---|---|
| License "MIT", description "A tiny widget", install "npm install widget", usage "npm start", one feature "Fast" | The file includes a shields.io license badge, a blockquote with the description, a table of contents, a Features list, fenced bash blocks for install and usage, and "Released under the MIT License." |
Sections the generator writes
| You fill in | Markdown it adds |
|---|---|
| Name | # heading |
| License | shields.io badge, a table-of-contents link, and a License section |
| Description | A blockquote under the heading |
| Features, one per line | A bullet list under ## Features |
| Install or usage command | A ```bash code block |
Blank fields are skipped, except the name, which falls back to "Project Name".
Create a clean, well-structured README.md for your project by filling in a short form. A good README is the front door of a repository, telling people what the project does, how to install it, how to use it and how to contribute, and a consistent structure makes your project look professional. Enter the project name, a description, installation and usage commands, features, and a license, and the tool assembles a Markdown file with sensible headings, a table of contents and a code block for commands. The live output updates as you type so you can see the result immediately, then copy it into your repo. Everything is generated in your browser, so your project details are never uploaded.
How to use README Generator
- Fill in your project name, description and details.
- Add install and usage notes.
- Choose a license.
- Copy the generated README.md.
Frequently asked questions
Does the README generator use AI?
No. It stitches the fields you type into fixed Markdown headings.
What license badge does it use?
A shields.io badge whose label is the license text you typed, URL-encoded.
Is the README uploaded?
No. The Markdown is built in the page. Copy it into your repo yourself.
Is README Generator any good?
Give your verdict. Sign-in needed to vote and comment.
Badge
Link this tool from a README, doc or site. The badge links back to this page.
[](https://yourhack.ai/readme-generator)