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.
173 lines
6.2 KiB
173 lines
6.2 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.2</p>
|
|
|
|
<p>Patroneo (which is Esperanto for “Pattern”) 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) (recommended, but not technically necessary)</li>
|
|
</ul>
|
|
|
|
|
|
<h4>Build Dependencies</h4>
|
|
|
|
<ul>
|
|
<li>Bash</li>
|
|
<li>Nuitka >= 0.6 (maybe earlier. Optional when running from source dir)</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</h2>
|
|
|
|
<p>There are multiple ways to run Patroneo which should give you the flexibility to configure your
|
|
system as you want.</p>
|
|
|
|
<p>We make no distinction if you installed Patroneo yourself or through the distributions package-manager.</p>
|
|
|
|
<p>The differences are: With or without NSM, with or without sound, installed or from the source dir.
|
|
The permutations are too many to describe them all in detail, but here are some useful modes:</p>
|
|
|
|
<h3>Installed with Non Session Manager (recommended)</h3>
|
|
|
|
<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 “Add Client to Session” and type in <code>patroneo</code>.
|
|
It should appear with an icon in the list and open its GUI.</p>
|
|
|
|
<h3>Installed without NSM</h3>
|
|
|
|
<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>
|
|
|
|
<h2>From source directory</h2>
|
|
|
|
<p>You can run Patroneo after extracting the release archive or cloning from git, without installation.</p>
|
|
|
|
<h3>Calfbox</h3>
|
|
|
|
<p>“Calfbox” is the name of our internal realtime midi/audio python module.</p>
|
|
|
|
<ul>
|
|
<li>You can either choose to install the module systemwide, which will make running all Laborejo Software Suite programs more convenient (when run from the source dir). Please consult <a href="https://github.com/kfoltman/calfbox">https://github.com/kfoltman/calfbox</a></li>
|
|
<li>Or you just run <code>./configure</code> and <code>make calfbox</code> without subsequent install, which creates a <code>site-packages</code> directory in the source dir.</li>
|
|
<li>A third option is <code>patroneo --mute</code> which runs without sound at all and does not need calfbox.</li>
|
|
</ul>
|
|
|
|
|
|
<h3>From source directory with NSM</h3>
|
|
|
|
<p>The developer uses this way to develop and use the software, so it will always be as stable as the
|
|
compiled version. 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>If you compiled without installing you can also symlink to <code>./patroneo.bin</code></p>
|
|
|
|
<h3>From source dir without NSM</h3>
|
|
|
|
<p>Use <code>./patroneo --save</code> (see above). If you compiled without installing you can also run <code>./patroneo.bin</code></p>
|
|
|
|
<h3>No NSM, no Make, No Sound</h3>
|
|
|
|
<p>Combining the above options you can start the program directly after unpacking or cloning from git:</p>
|
|
|
|
<p><code>./patroneo --save /tmp --mute</code></p>
|
|
|
|
<p>Or even shorter:</p>
|
|
|
|
<p><code>./patroneo -s /tmp -m</code></p>
|
|
|
|
<p>This is the minimal run mode which is only useful for testing and development. But if you only want
|
|
to look at the GUI and are not in the mood to install anything -including dependencies-, go ahead.</p>
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|