Assemble a solid README.md in five minutes
Your README is the first thing someone sees when they land in your repository. A bad README can bury a great project: no installation steps, no usage example, no shields.io badges, one wall of text. A good README has structure: name, description, quick start, usage, features, license.
This tool builds a complete README.md from a form. Every section is a Switch toggle: turn on title, badges, table of contents, installation, usage, features, configuration table, screenshots, tech stack, contributing, license, acknowledgments, footer. You fill in fields, the right pane shows the Markdown rendered like GitHub renders it (engine: marked).
Copy the result or download it as a file. Everything runs in the browser, nothing leaves your machine.
How to use it
- Toggle the sections you want by clicking the chips at the top. Each enabled section appears as a tab in the editor below.
- Pick a section tab in the editor (Badges, Features, ...) and fill in the fields. Tab cycles through inputs, the output refreshes as you type.
- Badges, pick a license, paste the repo for build status, paste the package name for npm/PyPI version and downloads. The generator builds the shields.io URLs for you.
- Quick Start, choose a package manager (npm/yarn/pnpm/bun/pip/cargo/go), type the package name, get a ready install command inside a code block.
- Tech Stack, click the technologies you use. They appear as a bullet list in the "Tech Stack" section.
- Preview on the right renders Markdown live. Switch to "Markdown" to see the raw file you will copy or download.
- Copy (whole file to clipboard) or Download (save as README.md). Drop into your repo, done.
When this is useful
Concrete situations where this generator saves real time:
- A fresh GitHub repository. You cloned a boilerplate, you have an empty README.md. Instead of writing from scratch or copy-pasting from another project, you assemble a coherent file here and paste it in five minutes.
- An npm / PyPI / cargo crate. A good README is not just a description, it is a version badge (people see the package is maintained), a downloads badge (social proof), a license badge (so people know they can use it), a build badge (so people see nothing is broken right now). The generator builds all four shields.io URLs for you.
- Onboarding new teammates. A standard README template helps juniors write documentation without wondering "what do I even put in here". Toggle "Quick Start" and "Configuration", the rest writes itself.
- A hackathon or prototype. You have two days and a working bit of code that has to look professional. A README with badges, screenshots, and a proper "Features" section is the difference between "school project" and "product".
- Migrating an old project. The old README is three lines and an outdated install command. You type the data here, generate a new file, commit.
- README for a portfolio repo. If your CV links a repo, the README is the landing page. Hero image, description, badges, stack, contact, all assembled here.
After generating, run the file through our Markdown linter to catch the usual small issues (skipped heading levels, mixed bullets, fenced code blocks without a language tag). If you want to add a table of contents to an existing large file, use the Markdown TOC generator.