Add some tests (#7)
[python-ant.git] / README.md
blobc7b87aadc1bc76b39704c761ec3c4001daab77ab
1 ANT
2 ===
4 Introduction
5 ------------
6 Python implementation of the ANT, ANT+, and ANT-FS protocols. For more
7 information about ANT, see http://www.thisisant.com/.
9 Can be used to communicate with ANT nodes using an ANT stick (USB).
11 This project came to be when I tried to download data for analysis from my
12 ANT+/ANT-FS enabled running watch under GNU/Linux. This eventually lead me to
13 attempting to port ANT_LIB and ANT_DLL (by Dynastream) to Linux. However, I
14 didn't quite like the library, the protocol is well documented and trivial to
15 implement, and I was going to have to write a ctypes-based wrapper afterwards
16 since I was only going to use the library from Python. Thus, I decided to
17 write a pure Python implementation.
20 Contact
21 -------
22 You can reach me via e-Mail and Google Talk/Jabber at:
23     martin at NOSPAM martinvillalba dot com
25 Documentation
26 -------------
27 Documentation will be a bit scarse for the time being, but everything public
28 should have at least a docstring by the time I make the first stable release.
31 License
32 -------
33 Released under the MIT/X11 license. See LICENSE for the full text.
36 Install
37 -------
38 % python setup.py install
41 Develop
42 -------
43 See DEVELOP.md for details.