# README template for your tool

The README is the user guide of your tool, kept in its folder. It is for you in six months, and for anyone (or any AI) who takes the tool over (lesson 8). One page at most.

```
# [Name of the tool]

## What it is for
[One or two sentences.]

## The files
- [file]: [what it is for]
- [file]: [what it is for]

## Opening it
[How, on which device, with which browser.]

## Where the data is
[Where it is kept, what can erase it.]

## Backing up and restoring
[The buttons, where to store the file, how to load it again.]

## Changing it safely
1. A Git version before ("before: …").
2. The change, then all the tests from the specification.
3. A Git version after, or a rollback.

## Last maintenance
[Date]: [what was checked]
```

## The request to your agent

```
Write README.md for this folder, in 25 lines at most, for someone who doesn't code, with exactly these parts: [paste the parts of the template].
Only what is true in the files of the folder. Do not create any other file.
```

## The README test

In a new session that reads only the README:

```
Read only README.md. In 3 lines: where is the data kept, how do I back it up, and what happens if I open the tool in another browser?
```

If the answer is wrong or incomplete, it is the README that needs fixing.

---
Practical AI Course, Maxime Toulemonde (EI, sole proprietorship). For your personal use and learning; redistribution prohibited without permission. Terms: maximetoulemonde.com/formation/en/conditions-utilisation