Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
michallaskowski committed Feb 25, 2021
1 parent f21063e commit 352c863
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@
## About the project

A common interface for (currently) two decoders:

* zwo files (xml format)
* fit files (binary format)

that allow to create a common model of a workout. See `Sources/WorkoutDecoderBase/WorkoutDecoding.swift` for model definitions.

Models are easy to use:

* intervals are flattened
* messages' time offset are normalized with respect to the beginning of the training

### Built with

* [FitFileParser](https://github.com/roznet/FitFileParser)
Expand Down Expand Up @@ -37,6 +43,7 @@ do {
## Roadmap

1. Need to add a test for FIT file decoding. Will need to find a file that I can publish, or find a tool to create one.
2. Potential support for FIT notes as messages.

For an app I am developing, ZWO and FIT file support is enough. MRC, ERG or other file support could be added if needed, but preferably by providing a PR :)
Workout model could be extended if there is also a need for that.
Expand Down

0 comments on commit 352c863

Please sign in to comment.