Changeset c6abc0c in OpenWorkouts-current

Timestamp:

Feb 13, 2019, 10:47:59 AM (5 years ago)

Author:

Borja Lopez <borja@…>

Branches:

current, feature/docs, master

Children:

57dcceb

Parents:

c660deb

Message:

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

Files:

• AUTHORS.txt (added)
• CHANGES.txt (modified) (1 diff)
• LICENSE.txt (added)
• README.txt (modified) (1 diff)
• setup.py (modified) (1 diff)

CHANGES.txt

@@ -1 @@
-0.0
----
+OpenWorkouts Changelog
+======================
 
-- Initial version.
+.. contents::
+
+
+Release summary
+---------------
+
+0.1.0, February 15, 2019:
+       Initial release, includes signup/login + per-user complete workout
+       management and an initial set of stats.
+
+Release details
+---------------
+
+0.1.0
++++++
+
+- New:
+
+  - User signup and login, password reset and basic user profile management
+
+  - Multi-sport workouts support
+
+    - Add workouts manually or upload using tracking files (gpx and fit
+      supported)
+
+    - Edit/update workouts manually or with tracking files
+
+  - Time-based archive for workouts in the user dashboard
+
+  - Time-based (global, per-month, per-week) stats and charts
+
+  - Detailed view of a workout, including basic workout info, stats and
+    an interactive map for those workouts with gps data

README.txt

@@ -2 +2 @@
 ============
 
-TBW, if you look for installation instructions, take a look at the script
-bin/install
+.. contents::
+
+
+What is it?
+-----------
+
+OpenWorkouts is a web app for tracking workouts.
+
+Some highlights:
+
+- Add workouts manually or upload them from gps/tracker files (gpx and fit
+  supported currently)
+
+- Time-based archive to access your workouts
+
+- Detailed view of each workout, including overview data (speed, distance,
+  time, hr, power, etc), charts and an interactive map view for those
+  workouts with gps tracking information
+
+- Tools to edit or update workouts from new gps/tracker files
+
+- Global stats (totals for distance, time, etc) and per-month, per-week
+  stats
+
+- Personal profile data containing basic info
+
+
+Install
+-------
+
+Quick and easy, the install script
+++++++++++++++++++++++++++++++++++
+
+The easies way to install is to grab a copy of the source code and run the
+install script.
+
+You can get the sources using git, cloning the main repository from this
+url::
+
+  https://openworkouts.org/sources/OpenWorkouts
+
+Once you have the sources, you can run the install script from a
+terminal/console::
+
+  ./bin/install
+
+If you don't have any of the needed dependencies, the script will tell you.
+Once everything is installed, you will see a message on screen telling you
+how to start the app.

setup.py

@@ -45 +45 @@
 setup(
     name='ow',
-    version='0.1',
+    version='0.1.0',
     description='OpenWorkouts, tracking your workouts openly',
     long_description=README + '\n\n' + CHANGES,