GitHub README Generator
Fill in a form — project name, description, features, install and usage steps, license — and get a ready-to-paste README.md.
948 views
A README, Without Starting From a Blank File
Fill in the fields — project name, one-line description, a longer summary, a feature list, install commands, a usage example, license and contact — and the tool assembles a clean, standard-shaped README.md as you type: title, badges, sections in the order GitHub visitors expect, code blocks fenced correctly. Copy it straight into your repository.
This is a template engine, not AI — it structures exactly what you type, nothing invented.
Frequently Asked Questions
Does this write my project description for me?
No — it's a template, not an AI writer. It takes what you type in each field and formats it into proper Markdown structure (headings, code fences, badges); the words are entirely yours.
What do the badges link to?
The license badge is a standard shields.io badge generated from your license choice — no account or setup needed, it just renders an image from a public URL when GitHub displays your README.
Can I edit the output after generating it?
Yes — it's plain Markdown text in a copyable box. Paste it into your repo's README.md and keep editing normally from there.
Similar Tools
Report a Problem
GitHub README Generator