A README is the front door to a small project. It should answer what the folder is for, which file to open first, and how to make a safe update. It is different from a detailed manual or a changelog.

Begin with a real first step

Download and extract the complete README practice kit. It contains the README plus all four linked files: DOCX source, PDF layout reference, blank form, and completed form. Keep all five together in the extracted folder; a standalone README cannot make its relative targets appear. Open the README in a local Markdown viewer that supports local links, or follow its visible filenames in a file manager. No remote repository is required.

A useful outline is:

# Project name
One sentence describing the purpose.

## Start here
Open the file that provides the first useful result.

## Contents
Explain the roles of the important files.

## Update
Describe the source, output, and verification step.

## Limits
State the actual boundaries.

Describe roles rather than list every filename

For the workshop kit, workshop-template.docx is the editable source, workshop-template.pdf is the checked layout reference, and the fillable practice pair demonstrates a separate form exercise. Explain those differences instead of calling everything “final.”

Use relative links for files that travel together. A link to your own /Users/... or C:\Users\... path will not help the recipient. Keep public web links distinguishable from local project files.

Write the update path

State which file is the source of truth for edits. In this example, edit a copy of the DOCX, increase its version deliberately, export a new PDF, and reopen every page. Do not imply that editing the PDF automatically updates the DOCX.

If there is no installation, say so. Do not add imaginary commands or requirements to make a small folder resemble a software project. If the project actually requires an application, name the supported one and the limits you know.

Test the README as instructions

Put yourself at the recipient’s starting point: open the folder, read only the README, follow its first link, and find the source and output. Confirm the referenced files exist. Ask whether any instruction depends on unstated knowledge.

GitHub renders README headings and relative links in repository contexts, but a standalone file may be viewed as source text. Keep the words readable in either form. This website provides the example as a download; it does not create a remote repository.

A good README is complete enough for the task and short enough to keep current. Remove claims you cannot support, and use an actual authorized contact if a real project needs one.

References & scope

These official references support the software instructions. Practice documents are original, fictional teaching examples; labels can vary by release.