Added some documentation to README #10

README.md

@@ -5,20 +5,87 @@ The goal is to have an advanced lap timer on your OpenTX compatible radio
 using as little controls as possible. It should be able to store race and
 lap data for analysis back at the computer.
 
-The timer automatically starts when in the Ready Mode and the throttle
-becomes active.
+Installation
+------------
 
-Controls
---------
+1. Copy `SCRIPTS/TELEMETRY/LAPTIMER.lua` to your SD card's `SCRIPTS/TELEMETRY`
+   folder. Create the folder if it does not exist.
+2. Copy the folder `BMP/LAPTIMER` to your SD card's `BMP` folder. Create the
+   folder if it does not exist.
+3. For any model you wish to enable the lap timer on, from the Telemetry setup
+   screen, add a new screen, choose *Script* as the Type, and `LAPTIMER.lua` for
+   the script name.
 
-Lap Timer only needs one control, preferably a momentary 2 position
-switch to record a lap.
+Configuration
+-------------
 
-When saving a race, all associated laps will be written to a CSV file on
-the SD card in the following layout:
+At the top of the script, you can alter a few items to customize the script to
+your likings.
+
+```
+local THROTTLE_CHANNEL = 'ch1'
+local LAP_SWITCH = 'sh'
+local SPEAK_GOOD_BAD = true
+local SPEAK_MID = true
+local SPEAK_LAP_NUMBER = true
+```
+
+* **THROTTLE_CHANNEL** - Output channel for your throttle. This is used to detect
+  when a race starts for the first time from the *Timer* page. The output channel
+  is used instead of `Thr` stick values because the channel output may be overridden
+  by Kill switches, for example. If the channel goes high, then your aircraft will
+  take off.
+* **LAP_SWITCH** - Switch you wish to use to indicate a lap was just completed. It
+  is best to put this on a momentary 2 position switch. On the Taranis, *SH* is
+  ideal.
+* **SPEAK_GOOD_BAD** - When `true`, your radio will say "Good" if the lap you just
+  completed is faster than your previous lap or "Bad" if slower.
+* **SPEAK_MID** - If true, a beep will occur when you reach the mid way point of the lap
+  as defined by half of your last laps time. For example, say your last lap was 60 seconds
+  exactly. If `SPEAK_MID` is true, at 30 seconds you will hear a long beep. If you are
+  further than 1/2 way around the course, then you are doing better than you did last lap.
+  If, however, you are not yet to the half way point, you are doing worse than you did
+  las lap.
+* **SPEAK_LAP_NUMBER** - When `true`, when a lap is completed, that number will be spoken.
+
+Usage
+-----
+
+To access the lap timer program, press and hold your *Page* button. This will
+then display any Telemetry screens you have defined. If you have multiple
+screens, press the *Page* button until you are on the lap timer screen.
+
+When first entering the Lap Timer screen, you will be presented with the
+*Configuration* page. Here you set how many laps you wish to run. Press your
+*Plus* and *Minus* keys to adjust accordingly, then press *Enter* to accept
+the value and go to the *Timing* page.
+
+The timer will automatically start when the throttle becomes active. To mark
+the completion of a lap, pull the SG momentary switch. Once you have completed
+all of the laps, the *Post Race* page will appear.
+
+On the *Post Race* page you will see a summary of your race including lap
+times, average time, total time and the number of laps completed. You can then
+use the *Plus* and *Minus* keys to select *Save* or *Discard.* If you choose
+*Save*, your race and lap details are appended to a file on your SD card named
+`laps.csv` in the following format:
 
   1. Start Time (YYYY-MM-DD HH:MM:SS)
   2. Lap Number
   3. Lap Count (total laps for race)
-  3. Time (in milliseconds, divide by 1,000 to get seconds)
-  4. Average Throttle
+  4. Time (in milliseconds, divide by 1,000 to get seconds)
+  5. Average Throttle
+
+**NOTE**: At this time, average throttle is not calculated but it is planned and
+added to the CSV export to allow for easy future addition.
+
+Special Actions
+---------------
+
+From the *Timer* page you can press *Exit* to abort the race. For example, maybe
+you crashed on lap 2 of 5. This will take you to the *Post Race* page, where you
+will be able to save or discard the incomplete race.
+
+From the *Timer* page you can press *Menu* to access the *Configuration* page
+and change any parameters accordingly. **NOTE**: If you do this during a race,
+your race will be lost.