Skip to content
New Tool

README Generator

Fill in what your project is, how to install it and how to use it, and get a README.md with the sections GitHub projects usually have, in the order you choose, ready to drop into your repository.

Loading README Generator…

Runs on your device. Nothing you type or paste is uploaded.

How to use the README Generator

  1. Pick a template, then fill in the project’s name, description and package details.
  2. Switch sections on or off and move them up or down; the preview shows the README as GitHub will.
  3. Download README.md, or continue in the Markdown Editor to add anything the form doesn’t cover.

Private by design

Many online converters send your text to their server, which matters for drafts, notes and anything confidential. README Generator runs entirely in your browser: nothing is uploaded, logged or stored on a server, and it keeps working with your network switched off. It’s free, with no account and no limits.

Questions

What should a good README include?

What the project does and who it’s for, how to install it, a short example of using it, and its license. Contributing guidelines, badges and screenshots help on bigger projects; the Standard template has a sensible mix.

Where do the badges come from?

The version, downloads, license and stars badges are images from shields.io, and the build badge is GitHub Actions’ own. They update by themselves once your package or repository is public.

Does it make the LICENSE file too?

No: the README points to it. On GitHub, choose Add file, then Create new file, name it LICENSE and pick a license template; GitHub fills in the full text.

Is my text uploaded anywhere?

No. Everything runs in your browser, so drafts, notes and documents stay on your device, and the tools keep working offline once the page has loaded.

Do I need an account?

No. Every Markdown tool is free to use without signing in, with no limits.

Part of Markdown Tools

18 free Markdown tools that run in your browser: an editor, slides, a README generator, Markdown to PDF, Word, Slack and Jira, a linter and more.

About Markdown Tools

See all

Label Maker

Tool · New

Print labels from Excel, Google Sheets or a CSV file: pick an Avery-compatible sheet, skip used labels and download a PDF. Addresses, QR codes and barcodes.

14 free printable planners and trackers: weekly and monthly plans, routines, meals, chores, budgets, workouts and more. Edit and print in your browser.

Draw names for Secret Santa in a minute: keep couples apart, set a spending limit, and send everyone a private link to reveal their match and share a wishlist. No sign-up, no emails.

Search by name, description or tag. Press Enter to see every match.