summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRALOVICH, Kristof <tade60@freemail.hu>2014-02-16 16:19:29 +0100
committerRALOVICH, Kristof <tade60@freemail.hu>2014-02-16 16:19:29 +0100
commit8923d2465529973efa3d9a3631d8dd8e90a21c9f (patch)
tree95e20a5b796ab3ff0f2c8d80b01dac8a342e303a
parent3194e4e1135ce6eade0e15f8d9b550a5d512bf8b (diff)
add readme file
in format suitable for github to display, including CI status
-rw-r--r--README.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..c0c61c6
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,21 @@
+=========
+ANT+minus
+=========
+
+Userspace implementation of a wire protocol similar to the
+ANT/ANT+/ANT-FS protocols. The goal is to be able to communicate with
+the Forerunner 310XT (or any other ANT/ANT+/ANT-FS capable device)
+watch in order to retrieve sports tracks.
+
+The C++ implementation is currently available under both Linux and
+win. Communication with watches other than the 310XT might (610XT and
+910XT are likely) work, but are untested. This project currently does
+not yet support Forerunner 405, but work is underway for 405
+support. Please report your experience to help improving the software.
+
+.. image:: https://secure.travis-ci.org/ralovich/antpm.png
+ :alt: Build Status
+ :target: http://travis-ci.org/ralovich/antpm
+ :width: 77px
+ :height: 19px
+