Skip to content

Commit 352c863

Browse files
michallaskowskiMichal Laskowski
authored and
Michal Laskowski
committed
Update readme
1 parent f21063e commit 352c863

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Diff for: README.md

+7
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,17 @@
33
## About the project
44

55
A common interface for (currently) two decoders:
6+
67
* zwo files (xml format)
78
* fit files (binary format)
89

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

12+
Models are easy to use:
13+
14+
* intervals are flattened
15+
* messages' time offset are normalized with respect to the beginning of the training
16+
1117
### Built with
1218

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

3945
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.
46+
2. Potential support for FIT notes as messages.
4047

4148
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 :)
4249
Workout model could be extended if there is also a need for that.

0 commit comments

Comments
 (0)