README Generator
Build a README with features, setup commands, screenshots and repository references. Review GitHub Flavored Markdown in a local preview, then copy or download README.md.
Check a GitHub README from a Clean Checkout
Find & replace in input
Undo: Ctrl/Cmd+Z · Redo: Ctrl/Cmd+Shift+Z or Ctrl+Y. Up to 20 steps and 4 million retained characters in this tab. Clear discards history.
README Generator: how to use it
- Enter a project name and description, or load the Trail Ledger example.
- Add the sections readers need. Leave other fields blank and choose whether to include a table of contents or badges.
- Generate README.md, review the preview and Markdown, then copy or download the file.
Limits and notes
Project name and description are required. Add up to 30 features, 12 technology names and one screenshot. Description and commands accept up to 4,000 characters per field. The preview shows links as text and images as labels. Saved Markdown can contain external URLs.
How your privacy works →README Generator: common questions
How do I show completed and planned features?
Put one feature on each line. Start it with [x] for a completed task or [ ] for an open task. Plain feature lines become bullets.
Why does the screenshot appear as a label in the preview?
The local preview renders its description without loading the image. The exported Markdown retains the path or URL. Check the image on the branch where you commit the README.
Does entering a license name create a license file?
The README includes the name and optional file link you provide. Add the actual license document to the repository separately.
Can I add badges for a GitHub repository?
Enter owner/repo and select Include GitHub status badges. The file includes Shields.io image URLs for stars, forks, issues and license. The preview uses text labels for all four.