README Generator

Create a README.md for your project from a simple form. Fill in the name and description, add badges, then write or switch on sections — features, installation, usage, screenshots, configuration, contributing and more — reorder them, and pick a license. A table of contents with working GitHub links is generated for you, and a live preview shows the result. Download README.md when it's ready. It's free and runs entirely in your browser.

GitHub heading anchors

HeadingAnchor
Getting Started#getting-started
Getting Started!#getting-started
C++ & Rust#c--rust
Getting Started (second time)#getting-started-1

When to use it

  1. Write a README for a new open-source project.
  2. Bring a bare repository up to a professional standard.
  3. Add a table of contents with links that actually work on GitHub.
  4. Produce a consistent README structure across a team's repositories.

How to Use

  1. Enter the project name and one-line description.
  2. Fill in, reorder or switch off sections.
  3. Choose a license and whether to include a table of contents.
  4. Check the preview, then copy or download README.md.

Features

  1. Eleven ready-made sections
  2. Reorder, rename and toggle sections
  3. GitHub-compatible table of contents
  4. License text from SPDX choices
  5. Live preview
  6. Copy or download
  7. 100% client-side

FAQs

What should a README include?

At minimum: what the project is, how to install it, how to use it and its license. Contributing guidelines and screenshots help most projects too.

Why don't my table of contents links work on GitHub?

GitHub creates anchors with specific rules — lowercase, punctuation removed, spaces as hyphens, numbered duplicates. This generator follows them exactly.

Can I reorder sections?

Yes, with the up and down arrows. Empty sections are left out automatically.

Which license should I choose?

MIT is the most permissive common choice; Apache-2.0 adds a patent grant; GPL and AGPL require derivatives to stay open source.

Is anything uploaded?

No. The README is generated in your browser.

Technical Details

The README is assembled from ordered sections — features, installation, usage, screenshots, configuration, API, tests, contributing, FAQ, acknowledgements and license — that can be renamed, reordered, switched off or left empty, in which case they're omitted rather than leaving a bare heading. The license section is written for you from the chosen SPDX license, or as an all-rights-reserved notice for proprietary code. The table of contents is generated with GitHub's own heading-anchor rules: text is lowercased, punctuation other than hyphens and underscores is dropped, each space becomes a hyphen, and repeated headings get -1, -2 suffixes — the details that make hand-written TOC links silently fail to jump on GitHub. The project's H1 is counted first, exactly as GitHub counts it. A live preview renders the Markdown with the same parser used elsewhere on the site and sanitizes the HTML before display. The result can be copied or downloaded as README.md.

Developer Tools

Developer Tools

  • Dockerfile Linter
  • SSH Config Generator
  • .dockerignore Generator
  • README Badge Generator
  • JSON to Zod
  • HTML Table Generator
  • Regex Cheatsheet
  • JSON to GraphQL