Added basic README.
This commit is contained in:
parent
d6d69b7aa5
commit
46bf3f028c
24
README.md
24
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
|
||||
```
|
||||
|
||||

|
||||
Loading…
Reference in a new issue