Browse Source

Update documentation

master
Nils 6 years ago
parent
commit
c479f9f401
  1. 12
      README.md
  2. 2
      documentation/out/english.html
  3. 2
      documentation/out/german.html
  4. 126
      index.html

12
README.md

@ -29,8 +29,11 @@ Download the latest code release on https://www.laborejo.org/downloads and extra
### Git Version
It is possible to clone a git repository.
`git clone --depth 1 --recurse-submodules git://laborejo.org:65423/patroneo.git`
If you want to update at a later date you must use
`git pull --recurse-submodules`
@ -51,9 +54,12 @@ If you want to update at a later date you must use
## Build
The default prefix is /usr/local
* `./configure --prefix=/usr`
* `make`
* `sudo make install`
`./configure --prefix=/usr`
`make`
`sudo make install`
## Starting through the Non Session Manager after installation (recommended)

2
documentation/out/english.html

@ -1114,7 +1114,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-27 15:47:48 +0100
Last updated 2019-01-27 15:49:19 +0100
</div>
</div>
</body>

2
documentation/out/german.html

@ -1195,7 +1195,7 @@ Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-27 15:47:48 +0100
Last updated 2019-01-27 15:49:19 +0100
</div>
</div>
</body>

126
index.html

@ -1,32 +1,3 @@
<ul>
<li><a href="#Patroneo">Patroneo</a></li>
<li><a href="#Contact-and-Information">Contact and Information</a></li>
<li><a href="#Installation-and-Starting">Installation and Starting</a>
<ul>
<li><a href="#Download">Download</a>
<ul>
<li><a href="#Release-Version">Release Version</a></li>
<li><a href="#Git-Version">Git Version</a></li>
</ul>
</li>
<li><a href="#Dependencies">Dependencies</a>
<ul>
<li>
<ul>
<li><a href="#Build-Dependencies">Build Dependencies</a></li>
</ul>
</li>
<li><a href="#Environment:">Environment:</a></li>
</ul>
</li>
<li><a href="#Build">Build</a></li>
<li><a href="#Starting-through-the-Non-Session-Manager-after-installation---28-recommended-29-">Starting through the Non Session Manager after installation (recommended)</a></li>
<li><a href="#Starting-through-NSM-without-building--2f--installation">Starting through NSM without building / installation</a></li>
<li><a href="#Starting-without-Non-Session-Manager">Starting without Non Session Manager</a></li>
</ul>
</li>
</ul>
<a name="Patroneo"></a>
<h1>Patroneo</h1>
<p>Patroneo (which is Esperanto for &ldquo;Pattern&rdquo;) is an easy to use pattern based midi sequencer that
@ -43,7 +14,6 @@ Connect external synthesizers and samplers to create sounds.</p>
<p>This README is just a short introduction. Consult the manual (see below) for more information.</p>
<a name="Contact-and-Information"></a>
<h1>Contact and Information</h1>
<ul>
@ -52,27 +22,25 @@ Connect external synthesizers and samplers to create sounds.</p>
</ul>
<a name="Installation-and-Starting"></a>
<h1>Installation and Starting</h1>
<a name="Download"></a>
<h2>Download</h2>
<a name="Release-Version"></a>
<h3>Release Version</h3>
<p>If the latest release is not available through your package manger you can build it yourself:
Download the latest code release on https://www.laborejo.org/downloads and extract it.</p>
<a name="Git-Version"></a>
<h3>Git Version</h3>
<p>It is possible to clone a git repository.
<code>git clone --depth 1 --recurse-submodules git://laborejo.org:65423/patroneo.git</code>
If you want to update at a later date you must use
<code>git pull --recurse-submodules</code></p>
<p>It is possible to clone a git repository.</p>
<p><code>git clone --depth 1 --recurse-submodules git://laborejo.org:65423/patroneo.git</code></p>
<p>If you want to update at a later date you must use</p>
<p><code>git pull --recurse-submodules</code></p>
<a name="Dependencies"></a>
<h2>Dependencies</h2>
<ul>
@ -82,7 +50,6 @@ If you want to update at a later date you must use
</ul>
<a name="Build-Dependencies"></a>
<h4>Build Dependencies</h4>
<ul>
@ -92,7 +59,6 @@ If you want to update at a later date you must use
</ul>
<a name="Environment:"></a>
<h3>Environment:</h3>
<ul>
@ -101,15 +67,16 @@ If you want to update at a later date you must use
</ul>
<a name="Build"></a>
<h2>Build</h2>
<p>The default prefix is /usr/local
* <code>./configure --prefix=/usr</code>
* <code>make</code>
* <code>sudo make install</code></p>
<p>The default prefix is /usr/local</p>
<p><code>./configure --prefix=/usr</code></p>
<p><code>make</code></p>
<p><code>sudo make install</code></p>
<a name="Starting-through-the-Non-Session-Manager-after-installation---28-recommended-29-"></a>
<h2>Starting through the Non Session Manager after installation (recommended)</h2>
<p>Starting Patroneo through the Non Session Manager after you installed patroneo system-wide
@ -117,7 +84,6 @@ is the recommended and only supported way. Start non-session-manager and load or
session. Then use the button &ldquo;Add Client to Session&rdquo; and type in patroneo.
It should appear with an icon in the list and open its GUI.</p>
<a name="Starting-through-NSM-without-building--2f--installation"></a>
<h2>Starting through NSM without building / installation</h2>
<p>Starting Patroneo through the Non Session Manager is possible without building or installation.
@ -131,7 +97,6 @@ or ~/bin, if that exists on your system.</p>
<p>This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox</p>
<a name="Starting-without-Non-Session-Manager"></a>
<h2>Starting without Non Session Manager</h2>
<p>You need to start patroneo from a terminal (or create a starter script).</p>
@ -163,35 +128,6 @@ you won&rsquo;t be able to save.</p>
<body>
<ul>
<li><a href="#Patroneo">Patroneo</a></li>
<li><a href="#Contact-and-Information">Contact and Information</a></li>
<li><a href="#Installation-and-Starting">Installation and Starting</a>
<ul>
<li><a href="#Download">Download</a>
<ul>
<li><a href="#Release-Version">Release Version</a></li>
<li><a href="#Git-Version">Git Version</a></li>
</ul>
</li>
<li><a href="#Dependencies">Dependencies</a>
<ul>
<li>
<ul>
<li><a href="#Build-Dependencies">Build Dependencies</a></li>
</ul>
</li>
<li><a href="#Environment:">Environment:</a></li>
</ul>
</li>
<li><a href="#Build">Build</a></li>
<li><a href="#Starting-through-the-Non-Session-Manager-after-installation---28-recommended-29-">Starting through the Non Session Manager after installation (recommended)</a></li>
<li><a href="#Starting-through-NSM-without-building--2f--installation">Starting through NSM without building / installation</a></li>
<li><a href="#Starting-without-Non-Session-Manager">Starting without Non Session Manager</a></li>
</ul>
</li>
</ul>
<a name="Patroneo"></a>
<h1>Patroneo</h1>
<p>Patroneo (which is Esperanto for &ldquo;Pattern&rdquo;) is an easy to use pattern based midi sequencer that
@ -208,7 +144,6 @@ Connect external synthesizers and samplers to create sounds.</p>
<p>This README is just a short introduction. Consult the manual (see below) for more information.</p>
<a name="Contact-and-Information"></a>
<h1>Contact and Information</h1>
<ul>
@ -217,27 +152,25 @@ Connect external synthesizers and samplers to create sounds.</p>
</ul>
<a name="Installation-and-Starting"></a>
<h1>Installation and Starting</h1>
<a name="Download"></a>
<h2>Download</h2>
<a name="Release-Version"></a>
<h3>Release Version</h3>
<p>If the latest release is not available through your package manger you can build it yourself:
Download the latest code release on https://www.laborejo.org/downloads and extract it.</p>
<a name="Git-Version"></a>
<h3>Git Version</h3>
<p>It is possible to clone a git repository.
<code>git clone --depth 1 --recurse-submodules git://laborejo.org:65423/patroneo.git</code>
If you want to update at a later date you must use
<code>git pull --recurse-submodules</code></p>
<p>It is possible to clone a git repository.</p>
<p><code>git clone --depth 1 --recurse-submodules git://laborejo.org:65423/patroneo.git</code></p>
<p>If you want to update at a later date you must use</p>
<p><code>git pull --recurse-submodules</code></p>
<a name="Dependencies"></a>
<h2>Dependencies</h2>
<ul>
@ -247,7 +180,6 @@ If you want to update at a later date you must use
</ul>
<a name="Build-Dependencies"></a>
<h4>Build Dependencies</h4>
<ul>
@ -257,7 +189,6 @@ If you want to update at a later date you must use
</ul>
<a name="Environment:"></a>
<h3>Environment:</h3>
<ul>
@ -266,15 +197,16 @@ If you want to update at a later date you must use
</ul>
<a name="Build"></a>
<h2>Build</h2>
<p>The default prefix is /usr/local
* <code>./configure --prefix=/usr</code>
* <code>make</code>
* <code>sudo make install</code></p>
<p>The default prefix is /usr/local</p>
<p><code>./configure --prefix=/usr</code></p>
<p><code>make</code></p>
<p><code>sudo make install</code></p>
<a name="Starting-through-the-Non-Session-Manager-after-installation---28-recommended-29-"></a>
<h2>Starting through the Non Session Manager after installation (recommended)</h2>
<p>Starting Patroneo through the Non Session Manager after you installed patroneo system-wide
@ -282,7 +214,6 @@ is the recommended and only supported way. Start non-session-manager and load or
session. Then use the button &ldquo;Add Client to Session&rdquo; and type in patroneo.
It should appear with an icon in the list and open its GUI.</p>
<a name="Starting-through-NSM-without-building--2f--installation"></a>
<h2>Starting through NSM without building / installation</h2>
<p>Starting Patroneo through the Non Session Manager is possible without building or installation.
@ -296,7 +227,6 @@ or ~/bin, if that exists on your system.</p>
<p>This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox</p>
<a name="Starting-without-Non-Session-Manager"></a>
<h2>Starting without Non Session Manager</h2>
<p>You need to start patroneo from a terminal (or create a starter script).</p>

Loading…
Cancel
Save