From 5695be96400e9ad2c7d0a849189c78ccd9540af9 Mon Sep 17 00:00:00 2001
From: Stephen D <stephen@scd31.com>
Date: Wed, 3 Jan 2024 22:36:41 +0000
Subject: [PATCH] Firmware update readme

---
 README.md | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 9867cb6..baa652c 100644
--- a/README.md
+++ b/README.md
@@ -49,9 +49,19 @@ The black hole can be configured with `set black_hole lat lon radius_meters`. Fo
 
 Note that you probably don't want to center your black hole exactly on your house. It may be possible to work out its position based on when exactly you stop transmitting. Instead, you should configure the black hole to overlap with your house, without being centered.
 
-## Compiling and flashing firmware
+## Updating firmware (Linux only)
 
-At the moment, updating the board's firmware requires manually compiling the new firmware and flashing it to the board. The setup for this isn't too bad and requires no specialized hardware.
+**NOTE:** Currently, updating the firmware can only be done on Linux. If you don't have a Linux computer, a Raspberry Pi, Virtual Machine, or Live-booted distro can be used.
+
+1. Download the flasher utility from [here](https://gitlab.scd31.com/cats/mobile-transceiver-software/builds/artifacts/master/browse/flasher?job=build-flasher).
+2. Run the utility:
+```bash
+chmod +x flasher-linux
+sudo ./flasher-linux
+```
+3. Follow the instructions on the screen. Afterwards, the board will restart automatically.
+
+## Compiling firmware from source (Linux only)
 
 ### Environment setup
 
@@ -68,7 +78,7 @@ cargo install flip-link # needed for building
 cargo install cargo-dfu # needed for flashing
 ```
 
-Finally, if you're on Linux, you may need to give yourself permission to write to the board.
+Finally, you may need to give yourself permission to write to the board.
 
 ```bash
 sudo cp udev.rules /etc/udev/rules.d/99-dfu-stm32.rules
-- 
GitLab