README Generator

Write a clear README for your project in a minute.

Private by design

Your inputs stay on your device and are not sent to our servers. Optional usage analytics does not receive your files or tool inputs.

README Generator

A ready-to-edit README.md for your project

Description and features

README.md

The result appears here.

Options

Project

Project name

GitHub repository

Package name

Installed with

Usage command

License

Extras

Author (optional)

Screenshot path or URL (optional)

Badges

Table of contents

Running tests section

Contributing section

A README is the front page of a project. This builds one in Markdown: a title, badges, a short description, features, how to install, how to use, how to test, how to contribute and the license.

Write features as lines starting with -.
Put the real command people will type in Usage command.
Add a screenshot or GIF path to make the page friendlier.
Pick your license first; the License Picker tool can help.

Built from templates in your browser. Badges use shields.io image URLs and are fetched only when the README is viewed, not by this tool.

Preparing tool

How to use README Generator

Describe your project and list features as bullet lines.
Set the name, repository, license and how people install it.
Copy the README or download README.md.

Read the detailed guide →

What are the limits of README Generator?

Gives you a solid starting point, not a finished document. Check the install and usage commands match your project. Badges load from shields.io when the README is viewed. Your text stays on your device.