update documentation
This commit is contained in:
Sam
parent
6117678ba1
commit
529adb0403
@ -7,6 +7,7 @@
|
||||
#### New Features
|
||||
|
||||
* [#91](https://github.com/SamR1/FitTrackee/issues/91) - Display elevation chart with min and max altitude of workout
|
||||
* [#90](https://github.com/SamR1/FitTrackee/issues/90) - Add user sports preferences
|
||||
* [#18](https://github.com/SamR1/FitTrackee/issues/18) - Better UI
|
||||
|
||||
#### Bugs Fixed
|
||||
@ -22,6 +23,8 @@
|
||||
* [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement
|
||||
* [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports
|
||||
|
||||
In this release 5 issue were closed.
|
||||
|
||||
|
||||
## Version 0.4.9 (2021/07/16)
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@
|
||||
#### New Features
|
||||
|
||||
* [#91](https://github.com/SamR1/FitTrackee/issues/91) - Display elevation chart with min and max altitude of workout
|
||||
* [#90](https://github.com/SamR1/FitTrackee/issues/90) - Add user sports preferences
|
||||
* [#18](https://github.com/SamR1/FitTrackee/issues/18) - Better UI
|
||||
|
||||
#### Bugs Fixed
|
||||
@ -22,6 +23,8 @@
|
||||
* [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement
|
||||
* [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports
|
||||
|
||||
In this release 5 issue were closed.
|
||||
|
||||
|
||||
## Version 0.4.9 (2021/07/16)
|
||||
|
||||
|
||||
@ -31,10 +31,15 @@ Administration
|
||||
|
||||
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
|
||||
|
||||
Account
|
||||
^^^^^^^
|
||||
Account & preferences
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
- A user can create, update and deleted his account
|
||||
- A user can reset his password (*new in 0.3.0*)
|
||||
- A user can set language, timezone and first day of week.
|
||||
- A user can set sport preferences (*new in 0.5.0*):
|
||||
- disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout.
|
||||
- change sport color (used for sport image and statistics)
|
||||
- can override stopped speed threshold (for next uploaded gpx files)
|
||||
|
||||
|
||||
Workouts
|
||||
@ -51,15 +56,19 @@ Workouts
|
||||
- Skiing (Cross Country) (**new in 0.5.0**)
|
||||
- Trail (**new in 0.5.0**)
|
||||
- Walking
|
||||
- (*new in 0.5.0*) Stopped speed threshold used by `gpxpy <https://github.com/tkrajina/gpxpy>`_ is not the default one (0.1 km/h instead of 1 km/h) for the following sports:
|
||||
- (*new in 0.5.0*) Stopped speed threshold used by `gpxpy <https://github.com/tkrajina/gpxpy>`_ is not the default one for the following sports (0.1 km/h instead of 1 km/h):
|
||||
- Hiking
|
||||
- Skiing (Cross Country)
|
||||
- Trail
|
||||
- Walking
|
||||
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user settings). The calendar displays up to 100 workouts.
|
||||
- Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance)
|
||||
- A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed
|
||||
- Workout edition and deletion. User can add a note
|
||||
|
||||
.. note::
|
||||
It can be overridden in user preferences.
|
||||
|
||||
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user preferences). The calendar displays up to 100 workouts.
|
||||
- Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance).
|
||||
- A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed.
|
||||
- Workout edition and deletion. User can add a note.
|
||||
- User statistics
|
||||
- User records by sports:
|
||||
- average speed
|
||||
@ -73,7 +82,7 @@ Workouts
|
||||
|
||||
Translations
|
||||
^^^^^^^^^^^^
|
||||
FitTrackee is available in English and French (which can be saved in the user settings).
|
||||
FitTrackee is available in English and French (which can be saved in the user preferences).
|
||||
|
||||
|
||||
Dashboard
|
||||
|
||||
@ -278,6 +278,7 @@
|
||||
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/91">#91</a> - Display elevation chart with min and max altitude of workout</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/90">#90</a> - Add user sports preferences</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/18">#18</a> - Better UI</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@ -300,6 +301,7 @@
|
||||
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/109">#98/#109</a> - Added stopped_speed_threshold to support slow movement</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/93">#84/#93</a> - Add elevation data and new sports</p></li>
|
||||
</ul>
|
||||
<p>In this release 5 issue were closed.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="version-0-4-9-2021-07-16">
|
||||
|
||||
@ -80,7 +80,7 @@
|
||||
<li><a class="reference internal" href="#">Features</a><ul>
|
||||
<li><a class="reference internal" href="#list">List</a><ul>
|
||||
<li><a class="reference internal" href="#administration">Administration</a></li>
|
||||
<li><a class="reference internal" href="#account">Account</a></li>
|
||||
<li><a class="reference internal" href="#account-preferences">Account & preferences</a></li>
|
||||
<li><a class="reference internal" href="#workouts">Workouts</a></li>
|
||||
<li><a class="reference internal" href="#translations">Translations</a></li>
|
||||
</ul>
|
||||
@ -174,11 +174,21 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="account">
|
||||
<h3>Account<a class="headerlink" href="#account" title="Permalink to this headline">¶</a></h3>
|
||||
<section id="account-preferences">
|
||||
<h3>Account & preferences<a class="headerlink" href="#account-preferences" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>A user can create, update and deleted his account</p></li>
|
||||
<li><p>A user can reset his password (<em>new in 0.3.0</em>)</p></li>
|
||||
<li><p>A user can set language, timezone and first day of week.</p></li>
|
||||
<li><dl class="simple">
|
||||
<dt>A user can set sport preferences (<em>new in 0.5.0</em>):</dt><dd><ul>
|
||||
<li><p>disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout.</p></li>
|
||||
<li><p>change sport color (used for sport image and statistics)</p></li>
|
||||
<li><p>can override stopped speed threshold (for next uploaded gpx files)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="workouts">
|
||||
@ -202,7 +212,7 @@
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt>(<em>new in 0.5.0</em>) Stopped speed threshold used by <a class="reference external" href="https://github.com/tkrajina/gpxpy">gpxpy</a> is not the default one (0.1 km/h instead of 1 km/h) for the following sports:</dt><dd><ul>
|
||||
<dt>(<em>new in 0.5.0</em>) Stopped speed threshold used by <a class="reference external" href="https://github.com/tkrajina/gpxpy">gpxpy</a> is not the default one for the following sports (0.1 km/h instead of 1 km/h):</dt><dd><ul>
|
||||
<li><p>Hiking</p></li>
|
||||
<li><p>Skiing (Cross Country)</p></li>
|
||||
<li><p>Trail</p></li>
|
||||
@ -211,10 +221,16 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><p>Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user settings). The calendar displays up to 100 workouts.</p></li>
|
||||
<li><p>Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
|
||||
<li><p>A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed</p></li>
|
||||
<li><p>Workout edition and deletion. User can add a note</p></li>
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>It can be overridden in user preferences.</p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user preferences). The calendar displays up to 100 workouts.</p></li>
|
||||
<li><p>Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance).</p></li>
|
||||
<li><p>A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed.</p></li>
|
||||
<li><p>Workout edition and deletion. User can add a note.</p></li>
|
||||
<li><p>User statistics</p></li>
|
||||
<li><dl class="simple">
|
||||
<dt>User records by sports:</dt><dd><ul>
|
||||
@ -235,7 +251,7 @@
|
||||
</section>
|
||||
<section id="translations">
|
||||
<h3>Translations<a class="headerlink" href="#translations" title="Permalink to this headline">¶</a></h3>
|
||||
<p>FitTrackee is available in English and French (which can be saved in the user settings).</p>
|
||||
<p>FitTrackee is available in English and French (which can be saved in the user preferences).</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="dashboard">
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -31,10 +31,15 @@ Administration
|
||||
|
||||
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
|
||||
|
||||
Account
|
||||
^^^^^^^
|
||||
Account & preferences
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
- A user can create, update and deleted his account
|
||||
- A user can reset his password (*new in 0.3.0*)
|
||||
- A user can set language, timezone and first day of week.
|
||||
- A user can set sport preferences (*new in 0.5.0*):
|
||||
- disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout.
|
||||
- change sport color (used for sport image and statistics)
|
||||
- can override stopped speed threshold (for next uploaded gpx files)
|
||||
|
||||
|
||||
Workouts
|
||||
@ -51,15 +56,19 @@ Workouts
|
||||
- Skiing (Cross Country) (**new in 0.5.0**)
|
||||
- Trail (**new in 0.5.0**)
|
||||
- Walking
|
||||
- (*new in 0.5.0*) Stopped speed threshold used by `gpxpy <https://github.com/tkrajina/gpxpy>`_ is not the default one (0.1 km/h instead of 1 km/h) for the following sports:
|
||||
- (*new in 0.5.0*) Stopped speed threshold used by `gpxpy <https://github.com/tkrajina/gpxpy>`_ is not the default one for the following sports (0.1 km/h instead of 1 km/h):
|
||||
- Hiking
|
||||
- Skiing (Cross Country)
|
||||
- Trail
|
||||
- Walking
|
||||
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user settings). The calendar displays up to 100 workouts.
|
||||
- Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance)
|
||||
- A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed
|
||||
- Workout edition and deletion. User can add a note
|
||||
|
||||
.. note::
|
||||
It can be overridden in user preferences.
|
||||
|
||||
- Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user preferences). The calendar displays up to 100 workouts.
|
||||
- Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance).
|
||||
- A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed.
|
||||
- Workout edition and deletion. User can add a note.
|
||||
- User statistics
|
||||
- User records by sports:
|
||||
- average speed
|
||||
@ -73,7 +82,7 @@ Workouts
|
||||
|
||||
Translations
|
||||
^^^^^^^^^^^^
|
||||
FitTrackee is available in English and French (which can be saved in the user settings).
|
||||
FitTrackee is available in English and French (which can be saved in the user preferences).
|
||||
|
||||
|
||||
Dashboard
|
||||
|
||||
Loading…
Reference in New Issue
Block a user