source: OpenWorkouts-current/docs/_build/html/_sources/install.rst.txt @ 0398a0c

currentfeature/docs
Last change on this file since 0398a0c was 0398a0c, checked in by Borja Lopez <borja@…>, 5 years ago

(#72) Created docs infraestructure, using sphinx and rst

  • Property mode set to 100644
File size: 1.7 KB
Line 
1Installation instructions
2=========================
3
4.. contents::
5
6Some things you will need before installing OpenWorkouts
7--------------------------------------------------------
8
91. Python_: The Python programming language, version 3.x (it has been tested
10   with versions >= 3.5).
11
122. `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
30The easiest way, using the installer
31------------------------------------
32
33This is the easiest way to install OpenWorkouts on any unix-like system (like
34Linux, any BSD-based system or MacOS).
35
36Grab a copy of the sources, either from https://openworkouts directly or from
37the `github releases page`_.
38
39Uncompress the tarball or zipped file (depending on what you did download)
40
41Run the installer, in a shell/console::
42
43  ./bin/install
44
45This script will take all the needed steps to set everything up for you.
46
47
48Setting 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
Note: See TracBrowser for help on using the repository browser.