Everything you need to install the workflow and run it on your own reports, written for readers with no prior programming experience. Read them in the order below.
| # | File | What it covers |
|---|---|---|
| 1 | prerequisites.md | What you need on your computer first. |
| 2 | installation.md | Download the project and set up the environment. |
| 3 | api_keys.md | The AI keys (optional; it also runs with no key at all in Rules-only mode). |
| 4 | quickstart.md | Run it on one report and read the result. |
| 5 | how_to_run.md | The full guide: batches, modes, and evaluation. |
| n/a | configuration.md | The config.py settings you can change (all with sensible defaults). |
New here? Start at prerequisites.md and work down. For an exhaustive reference of every setting, see ../reference/config_options.md.