add high level end-user todos

TODO.md

@@ -3,7 +3,7 @@ Items to complete before the first alpha release.
 
 * post sample video to signal forum
 * support non US frequencies
-* make an install script to let novices install software on their boards
+
 * retest BLE software update for both board types
 * default to enter deep sleep if no LORA received for two hours (indicates user has probably left the meshS)
 * first alpha release, article writeup for hackaday
@@ -15,6 +15,7 @@ Items to complete before the first alpha release.
 # Medium priority
 Items to complete before the first beta release.
 
+* leave lora receiver always on
 * rx signal measurements -3 marginal, -9 bad, 10 great, -10 means almost unusable.  So scale this into % signal strength.  preferably as a graph, with an X indicating loss of comms.  
 * assign every "channel" a random shared 8 bit sync word (per 4.2.13.6 of datasheet) - use that word to filter packets before even checking CRC.  This will ensure our CPU will only wake for packets on our "channel"  
 * Note: we do not do address filtering at the chip level, because we might need to route for the mesh
@@ -84,6 +85,7 @@ FIXME - instead look for standard solutions.  this approach seems really subopti
 # Pre-beta priority
 During the beta timeframe the following improvements 'would be nice' (and yeah - I guess some of these items count as features, but it is a hobby project ;-) )
 
+* make an install script to let novices install software on their boards
 * fix the frequency error reading in the RF95 RX code (can't do floating point math in an ISR ;-) 
 * See CustomRF95::send and fix the problem of dropping partially received packets if we want to start sending
 * swap out speck for hw-accelerated full AES https://github.com/espressif/arduino-esp32/blob/master/tools/sdk/include/esp32/hwcrypto/aes.h

bin/build-all.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-VERSION=0.0.3
+VERSION=0.0.4
 
 COUNTRIES="US EU CN JP"
 

docs/README.md

@@ -8,6 +8,22 @@ members and any text messages sent to your group chat.
 The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member.  The radios
 will optionally work with your phone, but no phone is required.
 
+### Uses
+
+* Outdoor sports where cellular coverage is limited. (Hiking, Skiing, Paragliding etc..)
+* Applications where closed source GPS communicators just won't cut it (it is easy to add features for pilots etc...)
+* Secure long-range communication within groups without depending on cellular providers
+
+### Features
+(Not all of these features are fully implemented yet - see below)
+
+* Very long battery life (should be about 8 days with the beta software)
+* Built in GPS and LORA radio, but we manage the radio automatically for you
+* Shows direction and distance to all members of your channel
+* Open and extensible codebase supporting multiple hardware vendors - no lock in to one vendor
+* Communication API for bluetooth devices (such as our Android app) to use the mesh
+* Eventually (within a couple of months) we should have a modified version of Signal that works with this project.
+ 
 Typical time between recharging the radios should be about eight days.
 
 This project is currently pre-alpha, but if you have questions please join our chat [![Join the chat at https://gitter.im/Meshtastic/community](https://badges.gitter.im/Meshtastic/community.svg)](https://gitter.im/Meshtastic/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
@@ -40,3 +56,17 @@ We don't yet distribute prebuilt binaries.  But soon (by Feb 22) we will have a
 
 For a nice TTGO 3D printable case see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
 For a nice Heltec 3D printable case see this [design](https://www.thingiverse.com/thing:3125854) by [ornotermes](https://www.thingiverse.com/ornotermes).
+
+# Disclaimers
+
+This project is still pretty young but moving at a pretty good pace.  Not all features are fully implemented in the current alpha builds.
+Most of these problems should be solved by the beta release:
+
+* Encryption is turned off for now
+* A number of software work items have to be completed before battery life matches our measurements, currently battery life is about two days
+* The current Android GUI is pretty ugly still
+* The Android API needs to be documented better
+* The Bluetooth API needs to be documented better 
+* The mesh protocol is turned off for now, currently we only send packets one hop distant
+
+For more details see the [device software TODO](https://github.com/geeksville/Meshtastic-esp32/blob/master/TODO.md) or the Android app [TODO](https://github.com/geeksville/Meshtastic-Android/blob/master/TODO.md).