README Generator
Fill in a short form and get a clean README.md with a title, summary, features, install and usage steps, license and optional badges.
How to write a README
Name the project
Add the project name and a one-line summary.
Describe it
Write the description and list the features, one per line.
Add install and usage
Give the install command and a usage example.
Finish up
Add the license, author, GitHub repo for badges, and optional Contributing section.
Save it
The file updates as you type. Copy it, or download it as README.md.
Worked example
This is what README Generator gives for its own sample values. Open the tool above and change anything to try your own.
- Project name
- My Project
- One-line summary
- A short sentence about what it does.
- Install command
- npm install my-project
- License name
- MIT
- Author
- GitHub repo (owner/name) for badges
README.md
# My Project > A short sentence about what it does. Explain the problem it solves and who it is for. ## Features - Fast and small - Works offline - No account needed ## Installation ...
About README Generator
Fill in a short form and get a clear README.md: a title, a one-line summary, a description, a feature list, installation and usage steps, a license section and optional badges and contributing notes.
FAQs
Can I edit the result?
Yes. It is plain Markdown, so use it as a first draft and add screenshots and links.
What are badges?
Small images at the top, such as the license or star count, that GitHub generates from your repo name.
Can I preview it?
Use Markdown to HTML Converter.