source: OpenWorkouts-current/docs/_build/html/about.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: 6.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>About OpenWorkouts &#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="#" />
18    <link rel="index" title="Index" href="genindex.html" />
19    <link rel="search" title="Search" href="search.html" />
20    <link rel="next" title="Installation instructions" href="install.html" />
21    <link rel="prev" title="OpenWorkouts documentation" href="index.html" />
22   
23  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
24 
25 
26  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
27
28  </head><body>
29 
30
31    <div class="document">
32      <div class="documentwrapper">
33        <div class="bodywrapper">
34         
35
36          <div class="body" role="main">
37           
38  <div class="section" id="about-openworkouts">
39<h1><a class="toc-backref" href="#id1">About OpenWorkouts</a><a class="headerlink" href="#about-openworkouts" title="Permalink to this headline"></a></h1>
40<div class="contents topic" id="contents">
41<p class="topic-title first">Contents</p>
42<ul class="simple">
43<li><a class="reference internal" href="#about-openworkouts" id="id1">About OpenWorkouts</a><ul>
44<li><a class="reference internal" href="#what-is-it" id="id2">What is it?</a></li>
45<li><a class="reference internal" href="#who-is-behind-it" id="id3">Who is behind it?</a></li>
46</ul>
47</li>
48</ul>
49</div>
50<div class="section" id="what-is-it">
51<h2><a class="toc-backref" href="#id2">What is it?</a><a class="headerlink" href="#what-is-it" title="Permalink to this headline"></a></h2>
52<p>The idea behind OpenWorkouts is to provide an open source tool everybody can
53use to keep track of workouts, in the form of a web-based application.</p>
54<p>This includes:</p>
55<ul class="simple">
56<li>Multi-user support, allowing users to signup with an account and then
57log in and out.</li>
58<li>Create workouts manually, providing info such as workout day, duration,
59distance, speed, elevation, etc</li>
60<li>Create workouts by uploading “tracking files”, like <a class="reference external" href="https://en.wikipedia.org/wiki/GPS_Exchange_Format">gpx</a> or <a class="reference external" href="https://en.wikipedia.org/wiki/GPS_Exchange_Format">ANT</a> <a class="reference external" href="https://www.thisisant.com/resources/fit">fit</a> files</li>
61<li>View workouts on a date-based interface</li>
62<li>View details of each workout</li>
63<li>View a profile page for each user with the user workouts, statistics, etc</li>
64<li>Tools to analize, compare and interact with workouts</li>
65<li>Tools to share workouts between users, manage club/group workouts and events</li>
66<li>and many more…</li>
67</ul>
68<p>If you are familiar with online services like <a class="reference external" href="https://strava.com">strava</a>, <a class="reference external" href="https://connect.garmin.com">garmin connect</a>, etc
69the idea of this project is to provide a similar solution, but in a package
70you can install locally in your computer or a server of your own.</p>
71</div>
72<div class="section" id="who-is-behind-it">
73<h2><a class="toc-backref" href="#id3">Who is behind it?</a><a class="headerlink" href="#who-is-behind-it" title="Permalink to this headline"></a></h2>
74<p>This is an Open Source project, with a community of developers who are working
75on it for free. You can see a list of people involved in the <a class="reference internal" href="AUTHORS.html"><span class="doc">OpenWorkouts Authors and Contributors</span></a>
76page.</p>
77</div>
78</div>
79
80
81          </div>
82         
83        </div>
84      </div>
85      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
86        <div class="sphinxsidebarwrapper">
87<h1 class="logo"><a href="index.html">OpenWorkouts</a></h1>
88
89
90
91
92
93
94
95
96<h3>Navigation</h3>
97<p class="caption"><span class="caption-text">Contents:</span></p>
98<ul class="current">
99<li class="toctree-l1 current"><a class="current reference internal" href="#">About OpenWorkouts</a><ul>
100<li class="toctree-l2"><a class="reference internal" href="#what-is-it">What is it?</a></li>
101<li class="toctree-l2"><a class="reference internal" href="#who-is-behind-it">Who is behind it?</a></li>
102</ul>
103</li>
104<li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a></li>
105<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">OpenWorkouts Changelog</a></li>
106<li class="toctree-l1"><a class="reference internal" href="AUTHORS.html">OpenWorkouts Authors and Contributors</a></li>
107</ul>
108
109<div class="relations">
110<h3>Related Topics</h3>
111<ul>
112  <li><a href="index.html">Documentation overview</a><ul>
113      <li>Previous: <a href="index.html" title="previous chapter">OpenWorkouts documentation</a></li>
114      <li>Next: <a href="install.html" title="next chapter">Installation instructions</a></li>
115  </ul></li>
116</ul>
117</div>
118<div id="searchbox" style="display: none" role="search">
119  <h3>Quick search</h3>
120    <div class="searchformwrapper">
121    <form class="search" action="search.html" method="get">
122      <input type="text" name="q" />
123      <input type="submit" value="Go" />
124      <input type="hidden" name="check_keywords" value="yes" />
125      <input type="hidden" name="area" value="default" />
126    </form>
127    </div>
128</div>
129<script type="text/javascript">$('#searchbox').show(0);</script>
130
131
132
133
134
135
136
137
138        </div>
139      </div>
140      <div class="clearer"></div>
141    </div>
142    <div class="footer">
143      &copy;2019, Borja Lopez Rio.
144     
145      |
146      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
147      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
148     
149      |
150      <a href="_sources/about.rst.txt"
151          rel="nofollow">Page source</a>
152    </div>
153
154   
155
156   
157  </body>
158</html>
Note: See TracBrowser for help on using the repository browser.