publish README.md

This commit is contained in:
brockdarnold 2026-06-14 07:18:58 +00:00
parent 6064b2774a
commit 9867a61a08

View file

@ -23,14 +23,26 @@ runs a **yield-based countdown** (timer mode).
Start with **timer mode** to prove delivery in 2 minutes, switch to **OCR** for hands-off. Start with **timer mode** to prove delivery in 2 minutes, switch to **OCR** for hands-off.
## Install on Goliath ## Install (Goliath + Adam's PC)
1. Install Python 3 (python.org installer — keep "Add to PATH" checked; it includes tkinter). Prereqs once: **git** (`winget install --id Git.Git -e`) and **Python 3**
2. In this folder: (python.org installer, keep "Add to PATH" checked — includes tkinter).
```
pip install -r requirements.txt First time — clone and run the single setup/update command:
copy config.ini.example config.ini ```
``` git clone https://git.armoredarmadillo.com/brockdarnold/eve-watcher.git
3. Edit `config.ini`: cd eve-watcher
python update.py
python eve_orehold_watcher.py --snip # one-time: aim OCR at the Ore Hold bar
```
(Or the one-liner bootstrap: `irm https://git.armoredarmadillo.com/brockdarnold/eve-watcher/raw/branch/main/install.ps1 | iex`)
**To get updates afterward, just:** `python update.py` — it does `git pull`, refreshes
deps, and restarts the watchers. Your `config.ini` (webhook + OCR snip) is **gitignored**,
so updates never overwrite it. The shared Discord webhook is already prefilled in
`config.ini.example`; `update.py` copies it to `config.ini` on first run.
### Manual config (optional)
`config.ini` is created for you, but you can edit it:
- `[ntfy] topic` → pick a private string (e.g. `eve-retriever-7h2k9`). On your - `[ntfy] topic` → pick a private string (e.g. `eve-retriever-7h2k9`). On your
phone, open the **ntfy** app → *Add subscription* → enter that same topic. phone, open the **ntfy** app → *Add subscription* → enter that same topic.
- For **timer mode**: set `[watcher] mode = timer` and `[timer] yield_m3_per_min` - For **timer mode**: set `[watcher] mode = timer` and `[timer] yield_m3_per_min`