README Generator — Build a GitHub README in Seconds
Fill in your project name, description, features, installation steps, and licence — and get a clean, ready-to-paste README.md instantly. No account, no upload — runs entirely in your browser.
How to use this tool
- Fill in your project name and description.
- Add sections for installation, usage, and license.
- Copy the generated Markdown README.
About README Generator
The README Generator turns a short form into a clean, GitHub-flavored Markdown README.md. You fill in a project name, an optional badge language, a description, a list of features, installation commands, usage commands, and a license, and the tool assembles them into a well-structured document that you can paste straight into a repository. The preview updates live, and it appears as soon as you enter a project name.
The generation logic builds the document section by section, including only the parts you actually fill in. The project name becomes a top-level H1 heading. If you type a badge language such as TypeScript or Python, the tool emits a shields.io badge image, URL-encoding spaces in the label so multi-word values stay valid. The description is added as a plain paragraph. The Features field is treated as one item per line: blank lines are discarded and each remaining line is turned into a Markdown bullet under a Features heading. The Installation and Usage fields are wrapped in fenced code blocks labeled as bash, which is why those inputs use a monospaced font in the form. Finally, unless you choose None, a License section is added with a sentence naming your chosen license; the options are MIT, Apache-2.0, GPL-3.0, ISC, and None.
This is handy when you are bootstrapping a new open-source project, standardizing READMEs across several repositories, or want a consistent structure without copying boilerplate from an old project. You enter your details once, copy the Markdown, and commit it.
Know the boundaries of what it produces. The tool generates the README text only; it does not create the shields.io badge image itself, so the badge renders only once the Markdown is viewed on a platform that loads the external image. Both the Installation and Usage blocks are tagged as bash, so if your usage example is actually JavaScript or Python you will want to change the language hint after pasting. License sections name the license but do not insert the full legal text or a LICENSE file, which you should add separately. Everything runs locally in your browser, so none of your project details are uploaded.
Frequently Asked Questions
- What output format does the generator produce?
- Standard GitHub-flavored Markdown. You copy the generated text and paste it into a README.md file in your repository. Headings, bullet lists, and fenced code blocks are all rendered by any Markdown-aware platform.
- How does the Features field work?
- It is parsed one feature per line. Each non-empty line becomes a bullet point under a Features heading, and blank lines are ignored. So you can type a simple list and the tool handles the Markdown bullet formatting for you.
- What does the Badge Language field do?
- If you enter a language name, the tool adds a shields.io badge image near the top of the README, with spaces in the label URL-encoded so multi-word names remain valid. The badge image is hosted by shields.io and only renders when the README is viewed somewhere that loads that external image.
- Why are the Installation and Usage examples shown as bash?
- Both fields are wrapped in code blocks tagged as bash, since installation steps are usually shell commands. If your usage example is in another language, edit the language hint after pasting so syntax highlighting matches.
- Which licenses can I choose?
- MIT, Apache-2.0, GPL-3.0, ISC, or None. Selecting a license adds a short License section naming it. Choosing None omits the section entirely.
- Does it create a LICENSE file with the full legal text?
- No. The License section only names the license in a sentence. You should still add the full license text in a separate LICENSE file in your repository, which most hosting platforms can scaffold for you.
- Why don't I see the preview right away?
- The generated README only appears once you have entered a project name, since that becomes the document's main heading. Add a name and the live preview shows up immediately, updating as you fill in the other fields.
- Is my project information sent anywhere?
- No. The README is assembled entirely in your browser, and nothing you type is uploaded to a server.
Embed this tool on your site
Free. One line of HTML — the tool runs in your visitor's browser, no data sent to anyone.
<iframe src="https://brevio.pro/embed/readme-generator" width="100%" height="600" loading="lazy" style="border:1px solid #e5e5e5;border-radius:8px" title="README Generator — brevio"></iframe> <p style="font:12px/1.4 sans-serif"><a href="https://brevio.pro/tools/readme-generator">README Generator</a> by <a href="https://brevio.pro">brevio</a></p>