diff --git a/README.md b/README.md index 4bc3e35..8e51d82 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 🏃♂️ Jogging Dashboard -An interactive Python Dash app to visualize, analyze, and explore your jogging or running sessions recorded as GPX/FIT files. +Interactive Python Dash app to visualize, analyze, and explore your jogging or running sessions recorded as GPX/FIT files.
@@ -14,7 +14,7 @@ An interactive Python Dash app to visualize, analyze, and explore your jogging o
- **Interactive Map View** with route trace and start/stop markers
- **Elevation Profile** with relative height and gradient fill
- **Speed Over Time** plot with smoothing and average line
-- **Heart Rate Over Time** plot with smoothing and average line (if .fit)
+- **Heart Rate Over Time** plot with smoothing and average line (if .fit file)
- **Deviation from Mean Speed** to see pacing consistency
- **Pace Bar Chart** showing per-kilometer pace breakdown
@@ -23,12 +23,12 @@ An interactive Python Dash app to visualize, analyze, and explore your jogging o
## Project Structure
```
-gpx_app.py # Main Dash application for gpx files
-gpx_files/ # Folder for storing GPX files
-fit_app.py # Main Dash application for fit files
-fit_files/ # Folder for storing FIT files
-requirements.txt # Required Python packages
-README.md # This file
+jogging_dashboard_browser_app.py # Main Dash application (Web-Version)
+jogging_dashboard_gui_app.py # Main Dash application (loading Web-Version in a Gui)
+gpx_files/ # Folder for storing GPX files
+fit_files/ # Folder for storing FIT files
+requirements.txt # Required Python packages
+README.md # Project description file
```
---
@@ -44,7 +44,7 @@ cd jogging-dashboard
### 2. Install dependencies
-We recommend using a virtual environment:
+It is recommend using a virtual environment:
```bash
python -m venv venv
@@ -75,11 +75,17 @@ pip install -r requirements.txt
### 3. Run the app
```bash
-python fit_app.py
+python jogging_dashboard_browser_app.py
```
Then open your browser and go to:
-[http://127.0.0.1:8050](http://127.0.0.1:8050)
+[http://127.0.0.1:8051](http://127.0.0.1:8051)
+
+Or as Gui-Version
+
+```bash
+python jogging_dashboard_gui_app.py
+```
---