From f1babfd5a8b67eedce1affd75d28c63ebf86008d Mon Sep 17 00:00:00 2001
From: Richard Meadows <richardeoin@gmail.com>
Date: Sun, 5 Jul 2015 21:20:30 +0100
Subject: [PATCH] Updated README, added some note to pre-flight checklist

---
 firmware/Pre-flight.md |  7 +++++++
 firmware/README.md     | 47 ++++++------------------------------------
 2 files changed, 13 insertions(+), 41 deletions(-)
 create mode 100644 firmware/Pre-flight.md

diff --git a/firmware/Pre-flight.md b/firmware/Pre-flight.md
new file mode 100644
index 0000000..eb55799
--- /dev/null
+++ b/firmware/Pre-flight.md
@@ -0,0 +1,7 @@
+## Pre-Flight Checklist ##
+
+- In `hw_config.h`
+  - `USE_XOSC` is set. Otherwise the symbol timing frequency will be
+    somewhat inaccurate.
+  - `APRS_ENABLE` is set if APRS is to be used on the flight
+  - `DEBUG_USE_INTWATCHDOG` can be disabled during flight. This saves some power
diff --git a/firmware/README.md b/firmware/README.md
index 0b8da7f..cbc6c95 100644
--- a/firmware/README.md
+++ b/firmware/README.md
@@ -15,49 +15,14 @@ be built using
 See [README-samd20-gcc-blackmagic.md](README-samd20-gcc-blackmagic.md)
 for more details.
 
-## Developement Framework ##
+## Test Suite ##
 
-Separate developement hardware exists, this has a separate MCU for
-current and voltage measurement, as well controling the voltage at the
-step-up input.
+The test suite is used to run test cases on real hardware. Test cases
+are written mostly in python and run using a gdb that has been built
+`--with-python`. It is still a work in progress but is quite handy
+when debugging.
 
-This is part of the development framework.
-
-The other part of the framework is several 'development scripts' that
-are still TODO
-
-## Verification Framework ##
-
-The verification suite ultimately allows a single command to return a
-PASS/FAIL vertict on the readiness of the system to fly. There should
-be no user input required during the tests - A test case that requires user
-input is actually a development script.
-
-#### REAL_HARDWARE
-
-If this flag is set, the test scripts can presume the MCU has full
-access to real flight hardware.
-
-Otherwise the tests must presume that their target is just the MCU on
-a developement board and set-up any required test harnesses as appropriate.
-
-#### DYNAMIC_TESTS
-
-If this flag is set, then the test cases may use dynamic data from
-the internet or other sources to test the tracker's performance in
-current real-world conditions. This may even include uploading the
-resulting test data to habhub or similar.
-
-Otherwise test cases must be perfectly deterministic and
-repeatable. Using psudo-random sequences to generate test data is
-acceptable, as long as a constant seed is used.
-
-### LONG_TEST
-
-If this flag is set, then the test case may make as many iterations it
-feels it needs for a full and thorough test.
-
-Otherwise test cases must take less than 1 second of real world runtime.
+See [test/README.md](test/README.md) for more details.
 
 ## Sources & Licensing ##