From a1bb12659b8c7950a76a542cdaa057d7a2cb2053 Mon Sep 17 00:00:00 2001 From: Selene ToyKeeper Date: Fri, 3 Nov 2023 13:02:42 -0600 Subject: documentation updates... - fleshed out main README.md a bit - improved github formatting for docs/which-hex-file.md - added 'make docs' to preview .md files as .html - ignore html files generated by 'make docs' - removed rampingios-v3.html file generated years ago --- docs/which-hex-file.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) (limited to 'docs/which-hex-file.md') diff --git a/docs/which-hex-file.md b/docs/which-hex-file.md index 380cff9..88cc1d2 100644 --- a/docs/which-hex-file.md +++ b/docs/which-hex-file.md @@ -1,12 +1,13 @@ # How to figure out which .hex file to use 1. Use the version check function (15 or more clicks from Off) to find out - which flavor of the firmware the light has installed. WRITE THIS DOWN. + which flavor of the firmware the light has installed. + **WRITE THIS DOWN.** -2. Look up the model number in the MODELS file, to get the name and MCU type: +2. Look up the model number in the MODELS file, to get the name and MCU type: https://toykeeper.net/torches/fsm/anduril2/MODELS -3. Find the newest firmware for that model. +3. Find the newest firmware for that model. https://toykeeper.net/torches/fsm/anduril2/?C=M;O=D If the version doesn't include a model number, you may be able to find @@ -20,20 +21,20 @@ the model in the PRODUCTS file to see which version it probably uses: The Version Check function should blink out a series of numbers in one of several formats: - - NNNN-YYYY-MM-DD - Anduril 2 from 2023-05 or later. + - `NNNN-YYYY-MM-DD` + Anduril 2 from 2023-05 or later. It's a model number and build date, with "buzz" flashes between sections. - NNNN: model number - YYYY: year - MM: month - DD: day + - `NNNN`: model number + - `YYYY`: year + - `MM`: month + - `DD`: day - - YYYYMMDDNNNN - Anduril 2 from 2023-05 or earlier. + - `YYYYMMDDNNNN` + Anduril 2 from 2023-05 or earlier. It's a build date and model number. - - YYYYMMDD - This is an old Anduril 1 version. It's just a build date. +- `YYYYMMDD` + This is an old Anduril 1 version. It's just a build date. If the model name isn't obvious, try looking it up in the PRODUCTS file. -- cgit v1.2.3