README Generator
Build a clean Markdown README for your project without writing it by hand. Fill in the project details, tick the sections you want, and the generator assembles the full Markdown with working badges.
Pair it with the Gitignore Generator when setting up a repository, and preview the result with Markdown to HTML.
How to use the README Generator
- 1 Fill in the project name, description and the sections you want.
- 2 Choose optional blocks such as badges, installation steps, usage examples and licence.
- 3 Preview the Markdown as you go.
- 4 Copy the whole file and paste it into your README.md.
How to Use
Complete as many fields as you need — anything left blank is simply omitted. Toggle sections on or off, then copy the Markdown into README.md in your repository.
- Optional sections, only included when used
- Shields.io badges generated automatically
- Install, usage, API and contributing blocks
- Live Markdown preview
- Copy the whole file in one click
Frequently asked questions
What should a README actually contain?
In order of usefulness: what the project does, how to install it, how to run it, and how to contribute. A screenshot or a short code example near the top does more than any amount of prose, because most visitors decide in a few seconds whether the project is what they need.
Which badges are worth adding?
Only ones that reflect something real and keep themselves current — build status, test coverage, published version. A badge that shows "build passing" on a project with no CI, or one that has not been updated in a year, is worse than no badge at all.
Should I include a licence section?
Yes, even briefly. Without a licence, the default is that nobody may legally reuse your code, which puts off both companies and contributors. A single line naming the licence and linking to the full text is enough.
Related Generators & Misc
You might also need
Tools from other categories that people pair with the README Generator: