You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

137 lines
4.7 KiB

<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="template/documentation/css/normalize.css" type="text/css">
<link rel="stylesheet" href="template/documentation/css/style.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Patroneo: Git Readme </title>
</head>
<body>
<h1>Patroneo</h1>
<p>For program version 1.1</p>
<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>
<h1>Contact and Information</h1>
<ul>
<li>Website <a href="https://www.laborejo.org">https://www.laborejo.org</a></li>
<li>Documentation and Manual <a href="https://www.laborejo.org/documentation/patroneo">https://www.laborejo.org/documentation/patroneo</a></li>
</ul>
<h1>Installation and Starting</h1>
<h2>Download</h2>
<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 <a href="https://www.laborejo.org/downloads">https://www.laborejo.org/downloads</a> and extract it.</p>
<h3>Git Version</h3>
<p>It is possible to clone a git repository.</p>
<p><code>git clone --recurse-submodules https://laborejo.org/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>
<h2>Dependencies</h2>
<ul>
<li>Glibc</li>
<li>Python 3.6 (maybe earlier)</li>
<li>PyQt5 for Python 3</li>
<li>DejaVu Sans Sarif TTF (Font)</li>
</ul>
<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>
<h3>Environment:</h3>
<ul>
<li>Jack Audio Connection Kit must be running</li>
<li>Non Session Manager</li>
</ul>
<h2>Build</h2>
<pre><code>./configure --prefix=/usr/local
make
sudo make install
</code></pre>
<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>
<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 above (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 <a href="https://github.com/kfoltman/calfbox">https://github.com/kfoltman/calfbox</a></p>
<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>Sending SIGUSR1 to the program in this mode will trigger a save.</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>