updated content from mjb
authorBdale Garbee <bdale@gag.com>
Thu, 31 Jan 2013 12:58:19 +0000 (23:58 +1100)
committerBdale Garbee <bdale@gag.com>
Thu, 31 Jan 2013 12:58:19 +0000 (23:58 +1100)
AltosDroid/index.mdwn

index ae95a24ee2ef3bcb12888ea560f70c286e19037c..2e1e3aeefc6a05d227f1411a525fcbc65e7256c0 100644 (file)
@@ -1,26 +1,64 @@
 # AltosDroid
 
-AltosDroid is the [Android](http://android.com) port of Altus Metrum's 
+AltosDroid is the [Android](http://www.android.com/) port of Altus Metrum's 
 ground station program, designed to work with the [TeleBT](../TeleBT)
 ground statiion hardware product.
 
 ## Where to Get It ##
 
-AltosDroid is availaable from the [Google Play](https://play.google.com/store/apps/details?id=org.altusmetrum.AltosDroid) store.
+The latest released version of AltosDroid is available from
+[Google Play&trade;](https://play.google.com/store/apps/details?id=org.altusmetrum.AltosDroid).
 
 ## What It Can Do ##
 
-Current features include telemetry logging to SD card, text to speech 
-announcements of flight state, and downlink frequency selection.
+Current features include:
+  * Display of key telemetry values
+  * Telemetry logging to SD card
+  * Text-to-speech announcements of flight state
+  * Downlink frequency selection.
+
+## Permissions ##
+
+AltosDroid requires the following permissions to be installed:
+
+ * NETWORK COMMUNICATION
+       * PAIR WITH BLUETOOTH DEVICES
+               This permission is needed to access Bluetooth communications,
+               allowing the pairing of and connection to TeleBT units.
+ * STORAGE
+       * MODIFY OR DELETE THE CONTENTS OF YOUR USB STORAGE MODIFY OR DELETE THE CONTENTS OF YOUR SD CARD
+               This permission is needed so that telemetry logs can be
+               written to the SD card.
+ * SYSTEM TOOLS
+       * ACCESS BLUETOOTH SETTINGS
+               This permission is used to request the enabling of Bluetooth
+               at startup.
 
 ## Source Code ##
 
 The source to AltosDroid is part of the [AltOS](../AltOS) repository, 
 which is always available from [git.gag.com](http://git.gag.com) 
-in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).  
+in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).
+
+The source is in the `altosdroid/` subdirectory, and is currently
+targetted at Android 2.3.3. You will need to have the Android SDK installed
+to build AltosDroid.
 
 ## Future Plans ##
 
 Future features we plan to add include flight computer configuration support,
 Google Maps integration, and "take me to my rocket" navigation.
 
+
+
+<center>
+<a href="https://play.google.com/store/apps/details?id=org.altusmetrum.AltosDroid">
+  <img alt="Android app on Google Play"
+       src="https://developer.android.com/images/brand/en_app_rgb_wo_45.png" />
+</a>
+
+
+Android is a trademark of Google Inc.
+Google Play is a trademark of Google Inc.
+</center>
+