# Tutorials

**Status: placeholder.** No tutorial is written yet. The titles below are planned
and may change.

| Tutorial | You will learn to | Status |
|---|---|---|
| 1. Build ERF with the example engine | Compile the coupling and `Tests/FireEngineExample`, run it, and find its output | To be written |
| 2. Write your own engine | Copy the example, register a new engine, and pass the restart check | To be written |
| 3. Run a FLARE fire | Build FLARE, run a small coupled fire, and read its diagnostics | To be written |

## Layout of each tutorial

Each tutorial will have its own page, `docs/tutorial_<name>.md`, with these
sections:

1. **Title and short introduction:** what the case is and how long it takes to run.
2. **You will learn to / Before you start:** the skills covered and what must be
   built first.
3. **The physical problem:** the setup, and the known answer if there is one.
4. **The input file:** the deck, with its main inputs explained.
5. **Run the case:** the exact commands.
6. **Read the log:** what to look for.
7. **The output:** which files appear and what they hold.
8. **Compare with a reference:** a closed-form answer or published numbers.
9. **Next steps:** the next tutorial and related pages.