Patroneo/index.html

<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
handles the three most important musical parameters: pitch, rhythm and dynamics.</p>

<p>Patroneo is primarily designed for educational purposes, where the main goal is to teach the
importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
you can use to create real music. The constraints it presents will more likely boost your
creativity than suppressing it.</p>

<p>Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play
musical notes. Switch the patterns on and off in a sequence to create a song structure.
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>
<li>Website https://www.laborejo.org</li>
<li>Documentation and Manual https://www.laborejo.org/documentation/patroneo</li>
</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>

<a name="Dependencies"></a>
<h2>Dependencies</h2>

<ul>
<li>Glibc</li>
<li>Python 3.6 (maybe earlier)</li>
<li>PyQt5 for Python 3</li>
</ul>


<a name="Build-Dependencies"></a>
<h4>Build Dependencies</h4>

<ul>
<li>Bash</li>
<li>Nuitka >= 0.6 (maybe earlier)</li>
<li>GCC (development is done on 8.2, but most likely you can use a much earlier version)</li>
</ul>


<a name="Environment:"></a>
<h3>Environment:</h3>

<ul>
<li>Jack Audio Connection Kit must be running</li>
<li>Non Session Manager</li>
</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>

<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
is the recommended and only supported way. Start non-session-manager and load or create a new
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.
So you don&rsquo;t need to call the steps avobe (configure, make, make install)</p>

<p>The developer uses this way to develop the software, so it will always be stable and supported.
But it is a bit less performant than building and installing it.</p>

<p>After extracting the release archive create a symlink from <code>patroneo</code> into your PATH. e.g. /usr/bin
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>

<p><code>patroneo --save DIRECTORY</code></p>

<p>Uses the given directory to save. The dir will be created or loaded from if already present. Use
the applications file menu to save (Ctrl+s).</p>

<p>You can use this to load and save the files from an existing NSM session. If you create a new
directory you can copy it manually to an NSM session directory, but that requires renaming the
directory to append the unique ID provided by NSM.</p>

<p>Closing through your window manager in this mode will actually quit the application without a
prompt to save changes.</p>

<p>It is possible to set /dev/null as save path, or any other nonsense path. The program will start but
you won&rsquo;t be able to save.</p>

<!DOCTYPE html>
<html>

<head>
    <link rel="stylesheet" href="template/documentation/css/normalize.css" type="text/css">
    <link rel="stylesheet" href="template/documentation/css/sakura.css" type="text/css">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title></title>
</head>

<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
handles the three most important musical parameters: pitch, rhythm and dynamics.</p>

<p>Patroneo is primarily designed for educational purposes, where the main goal is to teach the
importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
you can use to create real music. The constraints it presents will more likely boost your
creativity than suppressing it.</p>

<p>Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play
musical notes. Switch the patterns on and off in a sequence to create a song structure.
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>
<li>Website https://www.laborejo.org</li>
<li>Documentation and Manual https://www.laborejo.org/documentation/patroneo</li>
</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>

<a name="Dependencies"></a>
<h2>Dependencies</h2>

<ul>
<li>Glibc</li>
<li>Python 3.6 (maybe earlier)</li>
<li>PyQt5 for Python 3</li>
</ul>


<a name="Build-Dependencies"></a>
<h4>Build Dependencies</h4>

<ul>
<li>Bash</li>
<li>Nuitka >= 0.6 (maybe earlier)</li>
<li>GCC (development is done on 8.2, but most likely you can use a much earlier version)</li>
</ul>


<a name="Environment:"></a>
<h3>Environment:</h3>

<ul>
<li>Jack Audio Connection Kit must be running</li>
<li>Non Session Manager</li>
</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>

<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
is the recommended and only supported way. Start non-session-manager and load or create a new
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.
So you don&rsquo;t need to call the steps avobe (configure, make, make install)</p>

<p>The developer uses this way to develop the software, so it will always be stable and supported.
But it is a bit less performant than building and installing it.</p>

<p>After extracting the release archive create a symlink from <code>patroneo</code> into your PATH. e.g. /usr/bin
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>

<p><code>patroneo --save DIRECTORY</code></p>

<p>Uses the given directory to save. The dir will be created or loaded from if already present. Use
the applications file menu to save (Ctrl+s).</p>

<p>You can use this to load and save the files from an existing NSM session. If you create a new
directory you can copy it manually to an NSM session directory, but that requires renaming the
directory to append the unique ID provided by NSM.</p>

<p>Closing through your window manager in this mode will actually quit the application without a
prompt to save changes.</p>

<p>It is possible to set /dev/null as save path, or any other nonsense path. The program will start but
you won&rsquo;t be able to save.</p>


</body>
</html>