source: OpenWorkouts-current/README.txt @ c6abc0c

currentfeature/docs 0.1.0
Last change on this file since c6abc0c was c6abc0c, checked in by Borja Lopez <borja@…>, 4 years ago

Preparations for release of 0.1.0:

  • Updated README file with a brief description of the project + install instructions
  • Added LICENSE (3-clause BSD license)
  • Added AUTHORS file, with a list of authors and people contributing
  • Updated the CHANGES.txt changelog file
  • Set version on setup.py
  • Property mode set to 100644
File size: 1.2 KB
Line 
1OpenWorkouts
2============
3
4.. contents::
5
6
7What is it?
8-----------
9
10OpenWorkouts is a web app for tracking workouts.
11
12Some highlights:
13
14- Add workouts manually or upload them from gps/tracker files (gpx and fit
15  supported currently)
16
17- Time-based archive to access your workouts
18
19- Detailed view of each workout, including overview data (speed, distance,
20  time, hr, power, etc), charts and an interactive map view for those
21  workouts with gps tracking information
22
23- Tools to edit or update workouts from new gps/tracker files
24
25- Global stats (totals for distance, time, etc) and per-month, per-week
26  stats
27
28- Personal profile data containing basic info
29
30
31Install
32-------
33
34Quick and easy, the install script
35++++++++++++++++++++++++++++++++++
36
37The easies way to install is to grab a copy of the source code and run the
38install script.
39
40You can get the sources using git, cloning the main repository from this
41url::
42
43  https://openworkouts.org/sources/OpenWorkouts
44
45Once you have the sources, you can run the install script from a
46terminal/console::
47
48  ./bin/install
49
50If you don't have any of the needed dependencies, the script will tell you.
51Once everything is installed, you will see a message on screen telling you
52how to start the app.
Note: See TracBrowser for help on using the repository browser.