Menu
PDF Tools
Image Tools
Converters & Utilities
Seller & Print Tools
Accounting & Business
Calculators
Text & Writing Tools
Developer & Web Tools
Creator & Social Tools
Browser Utilities & Games
Document & Design Makers
Text & Developer Tools
Exam & Form Tools

README Generator

Fill in the name, a one-line description, features and a usage example, and get a clean README in Markdown. Sections you do not need can be left out.

How to use README Generator online

  1. Fill in the form. Name, description, features.
  2. Pick the install tool. And write a usage example.
  3. Choose the optional sections. Tests, contributing, licence.
  4. Copy the Markdown. Save it as README.md.

Why use this free README Generator

  • Ordered sections
  • Install command by tool
  • Fenced usage example
  • Tests and contributing
  • Licence section
  • Plain Markdown

A README that gets read

A README is the first thing a visitor reads. It should say what the project does, how to install it, how to use it, and under what licence it is shared. This page gives each of those a place and writes them in a steady order, so a new project starts with a clear page instead of a blank one.

The sections

The title and the one-line description come first. Features are listed from what you type, separated by semicolons. The installation section writes the right command for npm, yarn, pip, cargo, go or git. The usage section holds a code block in the language you name. Tests, contributing, licence and author are optional.

Names and commands

The package name is taken from the project name with spaces turned into hyphens, or you can type it. For git, a placeholder address is written unless you give the real one, and it is clearly a placeholder that you must replace. The page does not check that a package exists or that a command works.

Licence

The licence section names the licence you pick and points to a LICENSE file. It does not create that file. Copy the full text of the licence from its authors and place it in the project. Choose a licence on purpose, because it decides what others may do with your code.

Edit it afterwards

The result is a starting point. Add screenshots, a longer description, a table of options or a roadmap by hand, in the same Markdown. Everything is written in your browser and nothing is uploaded, so it is safe to try with a private project name.

Using the tool

As you type in the README Generator, the result appears at once. Open a text file into the box, or drop one on it.

README Generator: frequently asked questions

Does it create a LICENSE file?
No. It writes the licence section only. Add the full licence text yourself.
Can I add badges?
Not here. Add them by hand after the title if you want them.
What if my tool is not on npm or pip?
Choose git clone, or no install section.
How do I write several features?
Separate them with semicolons in the features box.
Which Markdown does it use?
Plain Markdown with headings, lists and fenced code blocks, which works on most hosting sites.
Does the README Generator keep a copy of my text?
It stays in your browser tab; the README Generator sends nothing anywhere.
How do I keep the result of the README Generator?
Yes. Copy the README Generator result, or press Use result as input and carry on with the new text.

Related searches for README Generator

  • README Generator online
  • free README Generator
  • README Generator online free
  • README Generator for mobile
  • README Generator without sign up
  • README Generator – Developer & Web Tools

README Generator is a free online tool on MAITBOX, in the Developer & Web Tools group. It runs in your browser, so what you type is not sent to a server. It works on Android and iPhone, and on Windows, Mac and Linux, with no download and no account.

More tools in Developer & Web Tools →

Search tools