Open Stetley

README template

A README that gets someone running in five minutes.

Use this template

Opens this template’s preview in Stetley Docs, free, with no account. Choose “Open the example” to write over it yourself, or “Use this template” for a draft from AI. Sign in when you want it saved to Stetley.

The README template, page 1 of 1, as Stetley Docs draws it in the Academic theme.The same page in the Editorial theme.The same page in the Botanical theme.
The real template, in Academic, Editorial, Botanical: drawn by Stetley Docs, not a mock-up.

Two ways to use it

Fill it in yourself

Opens the example you see here as a document, in the theme you choose. Every part is marked as a placeholder until you write over it. No AI, and it works offline.

Draft it with AI

Answer a few questions and the first draft is written into this design, with AI’s words marked until you accept them. Afterwards, Review suggests changes to what you wrote, each a tracked change with its reason. It runs on your own computer (a model in your browser, Ollama, Apple Intelligence) or with your own key; this one works with a small model on your computer.

It asks you for:

  • Project and what it does
  • Setup steps and commands you know (paste them exactly)

What’s in it

  1. What it is
  2. Quick start
  3. Configuration
  4. Development and testing
  5. Requirements, support, licence
  6. Contributing

Australia, the United Kingdom and the United States

The Australian example is written by hand; the British and American ones are the same page with that country’s dates, money, spelling, phone numbers and tax words, and the American one is on US Letter.

README template: the Australia example.

Use this template

Paper
A4
Dates
12 November 2026 (d/m/y)
Money
AUD, $

README template: the example page.The example page is the same one in every country; what changes is below.

Use this template

Paper
A4
Dates
12 November 2026 (d/m/y)
Money
GBP, £
README template: the United States example, on US Letter.

Use this template

Paper
Letter
Dates
November 12, 2026 (m/d/y)
Money
USD, $

Any theme

Every document template comes in ten themes. A theme changes the type, the colour and the drawing, never your words.

The README template in the Academic theme.
The same README template in the Editorial theme.
The same README template in the Botanical theme.

More engineering and IT templates

Every engineering and IT template · About Stetley Docs

Questions

Is the README template free?

Yes. It opens as an ordinary document that is yours to change, and it saves as a Word file or a PDF.

Do I need to pay for AI?

No. The template works without AI: open the example and write over it. If you want a first draft written for you, Docs uses a model on your own computer or your own key with any provider. Stetley runs no model of its own and does not train on your work.

Can I open it in Word?

Yes. Docs saves .docx, and what you make opens in Word with its layout, tables and tracked changes.

Use this template