Skip to content

Commit

Permalink
Update README.md - FIT doc, ANT SDK link (dtcooper#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
xmedeko authored and David Cooper committed Mar 4, 2018
1 parent 087b80b commit 03e2961
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,26 @@ python-fitparse

Here's a Python library to parse ANT/Garmin `.FIT` files.

Welcome to python-fitparse! After a few years of laying dormant we are back to
active development! The old version is archived as
[`v1-archive`](https://github.com/dtcooper/python-fitparse/releases/tag/v1-archive).

The FIT (Flexible and Interoperable Data Transfer) file protocol is specified by
ANT (http://www.thisisant.com/) and an SDK is available for download at
http://www.thisisant.com/pages/products/fit-sdk.
Install from [![PyPI](https://img.shields.io/pypi/v/fitparse.svg)](https://pypi.python.org/pypi/fitparse/):
```
pip install fitparse
```

FIT files
------------
- FIT files contain data stored in a binary file format.
- The FIT (Flexible and Interoperable Data Transfer) file protocol is specified
by [ANT](http://www.thisisant.com/).
- The SDK, code examples, and detailed documentation can be found in the
[ANT FIT SDK](http://www.thisisant.com/resources/fit).

Major Changes From Original Version
-----------------------------------

After a few years of laying dormant we are back to active development!
The old version is archived as
[`v1-archive`](https://github.com/dtcooper/python-fitparse/releases/tag/v1-archive).

* New, hopefully cleaner public API with a clear division between accessible
and internal parts. (Still unstable and partially complete.)

Expand Down Expand Up @@ -53,9 +62,8 @@ Major Changes From Original Version

Updating to new FIT SDK versions
--------------------------------
Download the latest SDK from http://www.thisisant.com/pages/products/fit-sdk

Update the profile:
- Download the latest [ANT FIT SDK](http://www.thisisant.com/resources/fit).
- Update the profile:
```
python3 scripts/generate_profile.py /path/to/fit_sdk.zip fitparse/profile.py
```
Expand Down

0 comments on commit 03e2961

Please sign in to comment.