aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRohan Martin <rohan.martin@thisisant.com>2013-11-15 21:19:00 +1100
committerRohan Martin <rohan.martin@thisisant.com>2013-11-15 21:19:00 +1100
commit61a9a5a1918e7ad8824552dd724b1531d3939019 (patch)
tree7ee4543939af7134a6cc5b6a7dba21b4ba5e2238
parentd4107eca65ac525fd7f8d9e43f3a545f8a6e2008 (diff)
downloadandroid_external_ant-wireless_ant_native-61a9a5a1918e7ad8824552dd724b1531d3939019.tar.gz
android_external_ant-wireless_ant_native-61a9a5a1918e7ad8824552dd724b1531d3939019.tar.bz2
android_external_ant-wireless_ant_native-61a9a5a1918e7ad8824552dd724b1531d3939019.zip
Detailed purpose of branches.
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2d7f30d..a67a03f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
-Linux ANT HAL library
-===================== \ No newline at end of file
+# Linux ANT HAL library #
+
+This repository contains the source to build the ANT HAL library (antradio_library.so) for use on Linux based platforms, including Android. Android makefiles are included to configure the build for a specific ANT part which is set in the board config.
+
+## Branches ##
+*Note: Development versions 1.6.1 and 1.6.2 were previously available on the _master_ branch. Any working branches created since version 1.6.0 (18 July 2013) must be rebased to the _development_ branch. While this may be irritating, it forces everyone on these branches to realise they are not using code which is "safe for release".*
+
+### master ###
+Versions that have been tested and are suitable for consumer devices.
+
+### development ###
+The latest, untested, development versions. These are made available for silicon vendors to verify code changes on parts/boards not available to ANT Wireless engineers.
+
+### <X>_debug ###
+Unmaintained, unsupported and untested code. These branches are purely used as a means of distributing in-progress work between engineers at different sites. They generally contain features and fixes developed by third parties.
+