source: OpenWorkouts-current/docs/_build/html/install.html @ 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: 7.5 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9    <title>Installation instructions &#8212; OpenWorkouts 0.2.0 documentation</title>
10    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
11    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
13    <script type="text/javascript" src="_static/jquery.js"></script>
14    <script type="text/javascript" src="_static/underscore.js"></script>
15    <script type="text/javascript" src="_static/doctools.js"></script>
16    <script type="text/javascript" src="_static/language_data.js"></script>
17    <link rel="author" title="About these documents" href="about.html" />
18    <link rel="index" title="Index" href="genindex.html" />
19    <link rel="search" title="Search" href="search.html" />
20    <link rel="prev" title="About OpenWorkouts" href="about.html" />
21   
22  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
23 
24 
25  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
26
27  </head><body>
28 
29
30    <div class="document">
31      <div class="documentwrapper">
32        <div class="bodywrapper">
33         
34
35          <div class="body" role="main">
36           
37  <div class="section" id="installation-instructions">
38<h1><a class="toc-backref" href="#id1">Installation instructions</a><a class="headerlink" href="#installation-instructions" title="Permalink to this headline"></a></h1>
39<div class="contents topic" id="contents">
40<p class="topic-title first">Contents</p>
41<ul class="simple">
42<li><a class="reference internal" href="#installation-instructions" id="id1">Installation instructions</a><ul>
43<li><a class="reference internal" href="#some-things-you-will-need-before-installing-openworkouts" id="id2">Some things you will need before installing OpenWorkouts</a></li>
44<li><a class="reference internal" href="#the-easiest-way-using-the-installer" id="id3">The easiest way, using the installer</a></li>
45<li><a class="reference internal" href="#setting-it-all-up-manually" id="id4">Setting it all up manually</a></li>
46</ul>
47</li>
48</ul>
49</div>
50<div class="section" id="some-things-you-will-need-before-installing-openworkouts">
51<h2><a class="toc-backref" href="#id2">Some things you will need before installing OpenWorkouts</a><a class="headerlink" href="#some-things-you-will-need-before-installing-openworkouts" title="Permalink to this headline"></a></h2>
52<ol class="arabic">
53<li><p class="first"><a class="reference external" href="https://python.org">Python</a>: The Python programming language, version 3.x (it has been tested
54with versions &gt;= 3.5).</p>
55</li>
56<li><p class="first"><a class="reference external" href="https://www.google.com/chrome">Google Chrome</a> + <a class="reference external" href="https://chromedriver.chromium.org">chromedriver</a>: This is not a requirement in order to run
57OpenWorkouts, but without it, for workouts that have gps tracking data, you
58won’t get a nice map displaying your route in the workouts lists (you will
59see the map in the details page though).</p>
60<p>We use Chrome to render a static image out of the route map.</p>
61<div class="admonition note">
62<p class="first admonition-title">Note</p>
63<p class="last"><a class="reference external" href="https://chromedriver.chromium.org">chromedriver</a> is usually bundled with Chrome, so installing chrome
64will install chromedriver too, but in some systems (MacOS for example)
65you will have to install it separately.</p>
66</div>
67<div class="admonition note">
68<p class="first admonition-title">Note</p>
69<p class="last">(If you prefer you can use <a class="reference external" href="https://www.chromium.org/Home">Chromium</a> instead of Chrome)</p>
70</div>
71</li>
72</ol>
73</div>
74<div class="section" id="the-easiest-way-using-the-installer">
75<h2><a class="toc-backref" href="#id3">The easiest way, using the installer</a><a class="headerlink" href="#the-easiest-way-using-the-installer" title="Permalink to this headline"></a></h2>
76<p>This is the easiest way to install OpenWorkouts on any unix-like system (like
77Linux, any BSD-based system or MacOS).</p>
78<p>Grab a copy of the sources, either from <a class="reference external" href="https://openworkouts">https://openworkouts</a> directly or from
79the <a class="reference external" href="https://github.com/openworkouts/OpenWorkouts/releases">github releases page</a>.</p>
80<p>Uncompress the tarball or zipped file (depending on what you did download)</p>
81<p>Run the installer, in a shell/console:</p>
82<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="nb">bin</span><span class="o">/</span><span class="n">install</span>
83</pre></div>
84</div>
85<p>This script will take all the needed steps to set everything up for you.</p>
86</div>
87<div class="section" id="setting-it-all-up-manually">
88<h2><a class="toc-backref" href="#id4">Setting it all up manually</a><a class="headerlink" href="#setting-it-all-up-manually" title="Permalink to this headline"></a></h2>
89<p><strong>TBW</strong></p>
90</div>
91</div>
92
93
94          </div>
95         
96        </div>
97      </div>
98      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
99        <div class="sphinxsidebarwrapper">
100<h1 class="logo"><a href="index.html">OpenWorkouts</a></h1>
101
102
103
104
105
106
107
108
109<h3>Navigation</h3>
110<p class="caption"><span class="caption-text">Contents:</span></p>
111<ul class="current">
112<li class="toctree-l1"><a class="reference internal" href="about.html">About OpenWorkouts</a></li>
113<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation instructions</a><ul>
114<li class="toctree-l2"><a class="reference internal" href="#some-things-you-will-need-before-installing-openworkouts">Some things you will need before installing OpenWorkouts</a></li>
115<li class="toctree-l2"><a class="reference internal" href="#the-easiest-way-using-the-installer">The easiest way, using the installer</a></li>
116<li class="toctree-l2"><a class="reference internal" href="#setting-it-all-up-manually">Setting it all up manually</a></li>
117</ul>
118</li>
119</ul>
120
121<div class="relations">
122<h3>Related Topics</h3>
123<ul>
124  <li><a href="index.html">Documentation overview</a><ul>
125      <li>Previous: <a href="about.html" title="previous chapter">About OpenWorkouts</a></li>
126  </ul></li>
127</ul>
128</div>
129<div id="searchbox" style="display: none" role="search">
130  <h3>Quick search</h3>
131    <div class="searchformwrapper">
132    <form class="search" action="search.html" method="get">
133      <input type="text" name="q" />
134      <input type="submit" value="Go" />
135      <input type="hidden" name="check_keywords" value="yes" />
136      <input type="hidden" name="area" value="default" />
137    </form>
138    </div>
139</div>
140<script type="text/javascript">$('#searchbox').show(0);</script>
141
142
143
144
145
146
147
148
149        </div>
150      </div>
151      <div class="clearer"></div>
152    </div>
153    <div class="footer">
154      &copy;2019, Borja Lopez Rio.
155     
156      |
157      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
158      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
159     
160      |
161      <a href="_sources/install.rst.txt"
162          rel="nofollow">Page source</a>
163    </div>
164
165   
166
167   
168  </body>
169</html>
Note: See TracBrowser for help on using the repository browser.