cleaned up the README.md file

This commit is contained in:
2025-11-26 18:54:52 +01:00
parent e422abc1b2
commit cf76e96db6

View File

@@ -86,7 +86,7 @@ pip install -r requirements.txt
python jogging_dashboard_browser_app.py
```
Then open your browser and go to:
Then open your browser and go to:
[http://127.0.0.1:8051](http://127.0.0.1:8051)
Or as Gui-Version
@@ -99,20 +99,20 @@ python jogging_dashboard_gui_app.py
## Uploading Your GPX File
1. Export your activity (e.g., from Strava, Garmin, etc.) as a `.gpx` or `.fit` file
2. Place the file into the `gpx_files/` or `fit_files/` directory
1. Export your activity (e.g., from Strava, Garmin, etc.) as a `.gpx` or `.fit` file
2. Place the file into the `gpx_files/` or `fit_files/` directory
3. Select it via the dropdown in the dashboard
---
## Tech Stack
- **Dash** (by Plotly) for building the UI and graphs
- **Pandas** for data wrangling
- **Plotly Graph Objects & Express** for advanced visuals
- **Dash** (by Plotly) for building the UI and graphs
- **Pandas** for data wrangling
- **Plotly Graph Objects & Express** for advanced visuals
- **Scipy** for smoothing the data lines
- **GPXPy** for parsing `.gpx` files
- **Numpy** for vectorized math and smoothing
- **GPXPy** for parsing `.gpx` files
- **Numpy** for vectorized math and smoothing
- **FitParse** for parsing `.fit` files
---
@@ -126,8 +126,8 @@ You can test the dashboard by either placing any valid `.gpx` file in the `gpx_f
## To Do / Ideas
- [X] Plotting heart rate data - **if** FIT file choosen.
- [ ] Export as PDF report
- [ ] Multi-run comparison
- [ ] Export as PDF report
- [ ] Multi-run comparison
---
@@ -139,5 +139,5 @@ This project is open source under the [MIT License](LICENSE).
## Feedback / Contributions
Feel free to open issues or pull requests!
Feel free to open issues or pull requests!
If you enjoy this project, a ⭐️ star is always appreciated.