Free README template generator

Answer a few questions and get a README skeleton in Markdown, with the sections a first-time visitor looks for, in the order they look for them. It runs in your browser. Nothing is uploaded or stored.

How to use the skeleton

Anything in [square brackets] is a fact only you know: a version number, a command, a URL. The generator leaves those as visible placeholders instead of guessing, so you can't ship a wrong install command by accident. Search the file for "[" before you commit.

The order is deliberate. The tagline comes first because it is what people read in search results and on your profile. The quick start comes before the long explanation because most visitors decide in the first screen whether to try the project. Usage with a real example output comes next, since seeing a result is more convincing than a feature list.

What it does not do

It gives you structure, not writing. It can't describe what is special about your project or check that your commands work. Once you have filled it in, run the result through the free README checker for a structure score, and check your sidebar text with the repo description and topics checker. The README checklist explains each section in more detail.