README Generator
A structured README.md with badges, features, install, usage, contributing and license.
About this tool
Fill in the project name, GitHub repository, package name and manager, license and author, a one-line description, features, a usage example and optional configuration notes. The README.md is written as you type with a live preview, a table of contents once it has enough sections, and copy and download buttons.
What a good README does
The README is the front page of a project, and visitors decide in the first screen whether to keep reading. It needs to answer four questions in order: what is this, why would I use it, how do I install it, and how do I use it. The generator lays the sections out in that order — title and badges, a one-sentence description, features, installation, usage in a fenced code block, configuration, contributing and license — because that is how people scan. Badges come from shields.io and show the latest version, licence and stars; they only render once the repository and package exist. A usage example that can be copied and run is worth more than any description, and a screenshot or GIF is worth adding for anything with a user interface. The output is a structure to edit, not finished documentation: replace the placeholders with real commands and examples. The markdown preview tool edits the result (What Markdown is, the syntax that matters, and where it works explains the syntax), the license generator writes the LICENSE file, the .gitignore generator finishes the repository, and the markdown table generator builds tables.
Frequently asked questions
What should a README include?
At minimum: what the project does, how to install it, a usage example, and the licence. Contributing guidelines and configuration help once others use it.
Why don't the badges show in the preview?
They are images served by shields.io for your real repository and package. The preview shows placeholders; they appear on GitHub once the project exists.
Can I use it for a non-code project?
Yes — set the package manager to None and use the sections that apply, or edit the markdown freely.
Is my project information uploaded?
No. The README is generated in your browser.