From 46bf3f028c60ac4bc63ae38fc228bc80e0c5c048 Mon Sep 17 00:00:00 2001 From: Filip Date: Sun, 16 Mar 2025 20:04:19 +0100 Subject: [PATCH] Added basic README. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..15550e4 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Usage + +A simple way to create a comparison: + +```sh +# Clone this repository. +git clone https://github.com/StrajnarFilip/analyze-sport-data +# Change directory into repository. +cd analyze-sport-data/ +# Copy any amount of FIT or TCX files into this directory. +cp /home/example/example.fit . +cp /home/example/example.tcx . +# Install this package. +python -m pip install . +# Alternatively you can install using poetry: +# poetry install + +# Run included example.py script: +python example.py +# Alternatively you can run the script using poetry: +# poetry run python example.py +``` + +![Example](https://github.com/StrajnarFilip/analyze-sport-data/blob/master/example.png?raw=true) \ No newline at end of file