1 | Installation instructions |
---|
2 | ========================= |
---|
3 | |
---|
4 | .. contents:: |
---|
5 | |
---|
6 | Some things you will need before installing OpenWorkouts |
---|
7 | -------------------------------------------------------- |
---|
8 | |
---|
9 | 1. Python_: The Python programming language, version 3.x (it has been tested |
---|
10 | with versions >= 3.5). |
---|
11 | |
---|
12 | 2. `Google Chrome`_ + chromedriver_: This is not a requirement in order to run |
---|
13 | OpenWorkouts, but without it, for workouts that have gps tracking data, you |
---|
14 | won't get a nice map displaying your route in the workouts lists (you will |
---|
15 | see the map in the details page though). |
---|
16 | |
---|
17 | We use Chrome to render a static image out of the route map. |
---|
18 | |
---|
19 | .. note:: |
---|
20 | |
---|
21 | chromedriver_ is usually bundled with Chrome, so installing chrome |
---|
22 | will install chromedriver too, but in some systems (MacOS for example) |
---|
23 | you will have to install it separately. |
---|
24 | |
---|
25 | .. note:: |
---|
26 | |
---|
27 | (If you prefer you can use Chromium_ instead of Chrome) |
---|
28 | |
---|
29 | |
---|
30 | The easiest way, using the installer |
---|
31 | ------------------------------------ |
---|
32 | |
---|
33 | This is the easiest way to install OpenWorkouts on any unix-like system (like |
---|
34 | Linux, any BSD-based system or MacOS). |
---|
35 | |
---|
36 | Grab a copy of the sources, either from https://openworkouts directly or from |
---|
37 | the `github releases page`_. |
---|
38 | |
---|
39 | Uncompress the tarball or zipped file (depending on what you did download) |
---|
40 | |
---|
41 | Run the installer, in a shell/console:: |
---|
42 | |
---|
43 | ./bin/install |
---|
44 | |
---|
45 | This script will take all the needed steps to set everything up for you. |
---|
46 | |
---|
47 | |
---|
48 | Setting it all up manually |
---|
49 | -------------------------- |
---|
50 | |
---|
51 | **TBW** |
---|
52 | |
---|
53 | |
---|
54 | .. _Python: https://python.org |
---|
55 | .. _`Google Chrome`: https://www.google.com/chrome |
---|
56 | .. _Chromium: https://www.chromium.org/Home |
---|
57 | .. _chromedriver: https://chromedriver.chromium.org |
---|
58 | .. _`github releases page`: https://github.com/openworkouts/OpenWorkouts/releases |
---|