README generator

Fill in a few fields and get a polished README.md for your project — with a live preview. Copy it or download the file. Everything runs in your browser; nothing is uploaded.

Basics

Project name

Short tagline

Description

Sections

Installation

Usage

Features (one per line)

Contributing

Project info

License

Code language (for fenced blocks)

Author

Repository URL

Badges

License badge PRs welcome Made with love GitHub stars

Add a table of contents Use emoji in headings

Everything runs in your browser. No upload, no sign-up.

How it works

STEP 1

Fill in your project

Type the name, a short description, install and usage steps, and list your features one per line.

STEP 2

Pick badges & options

Choose a license, add badges, and turn on a table of contents or emoji headings if you like.

STEP 3

Copy or download

See a live preview, then copy the Markdown or download a ready-to-use README.md — nothing is uploaded.