Fill in a short form and get a complete GitHub README.md: badges, description, features, installation, usage, configuration, contributing and license sections.
Works in your browser. What you paste or upload is processed on your device.
Enter the name, a one-line summary and a description.
Give the GitHub owner/repo and npm package to generate badges and the clone command, and pick a license.
List features, prerequisites, install commands, a usage example and environment variables. Leave anything blank to skip it.
Check the preview and download README.md into the root of your repository.
A README generator writes the README.md file for a software project from a few answers: the project name and summary, what it does, how to install and use it, and how to contribute. Fill in the form on this page and the README builds itself on the right with a live preview, ready to download as README.md.
The file follows the layout most GitHub projects use: a title, shields.io badges (license, npm version, stars, last commit, open issues), a one-line summary and description, an optional demo link and screenshot or GIF, then Features, Built with, Getting started (prerequisites and install commands, with git clone added when you give the repository), Usage with a highlighted code example, Configuration as a table of environment variables, Contributing steps, License and Author. A table of contents is added when there are enough sections. Empty fields are left out.
The result is plain Markdown, so you can edit it afterwards in the Markdown editor or your code editor.
The README is the first thing people see on a repository and decides whether they try the project. A complete, consistent structure answers the usual questions (what is it, how do I install it, how do I use it, can I contribute, what's the license) without starting from a blank page.
Something else? Ask the team
At least: what the project does, how to install it, how to use it, and the license. Badges, screenshots, configuration, a contributing guide and a table of contents help larger projects.
In the root folder of the repository. GitHub, GitLab and Bitbucket show it on the project's front page.
Yes. They are shields.io image links that update automatically with your repository's stars, last commit, issues and npm version once the repo or package is public.
Yes. It is plain Markdown. Open it in the Markdown editor here, or in any code editor.
No. It adds a License section that points to a LICENSE file. Add the licence text itself with GitHub's Add file > Create new file > LICENSE template picker.
Each one opens on its own page and works straight away, with no sign-up.
Format Markdown and find syntax problems
Convert Markdown to HTML
Convert HTML to Markdown
Write Markdown with a live preview
Explore more free tools:Schema GeneratorMeta Tag GeneratorLLMs.txt GeneratorBrowse all free tools
README Generator is one piece of the puzzle. See how ChatGPT, Gemini, Perplexity, and Google AI Overviews actually view your brand, and get a prioritised list of fixes, with a free AEO & GEO audit from AI Rank Lab.
Run a free AEO & GEO audit or View pricing.
Site audit
Paste your site. The free audit scores it for SEO, answer engines and generative engines, with the fixes.
