Nils
5 years ago
2 changed files with 174 additions and 1 deletions
@ -0,0 +1,173 @@ |
|||
|
|||
<!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>Laborejo: Git Readme </title> |
|||
</head> |
|||
|
|||
<body> |
|||
|
|||
<h1>Laborejo</h1> |
|||
|
|||
<p>Program version 2.0</p> |
|||
|
|||
<p>Laborejo (Esperanto: Workshop) is a MIDI sequencer based on classical music notation. |
|||
Its main purpose is to compose and produce “traditional” music, such as instrumental pieces, |
|||
soundtracks and other music normally played back by samplers.</p> |
|||
|
|||
<p>Unlike other notation editors Laborejo is not meant primarily to print out sheets of notation but |
|||
to create music for your computer: You get all the tools you know from other midi sequencers for |
|||
maximum fine control to get exactly the music you want!</p> |
|||
|
|||
<p>Working in Laborejo is very fast and efficient by using a combination of midi input and typing.</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/laborejo">https://www.laborejo.org/documentation/laborejo</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/laborejo.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> |
|||
<li>Lilypond >= 2.19 (optional)</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 Laborejo which should give you the flexibility to configure your |
|||
system as you want.</p> |
|||
|
|||
<p>We make no distinction if you installed Laborejo 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.</p> |
|||
|
|||
<h3>Installed with Non Session Manager (recommended)</h3> |
|||
|
|||
<p>Starting Laborejo through the Non Session Manager after you installed laborejo 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>laborejo</code>. |
|||
It should appear with an icon in the list and open its GUI.</p> |
|||
|
|||
<h3>Installed without NSM</h3> |
|||
|
|||
<p>If you start laborejo directly it will present you with a dialog to choose your session directory.</p> |
|||
|
|||
<p>You can also start laborejo from a terminal (or create a starter script).</p> |
|||
|
|||
<p><code>laborejo --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 Laborejo 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>laborejo --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>laborejo</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>./laborejo.bin</code></p> |
|||
|
|||
<h3>From source dir without NSM</h3> |
|||
|
|||
<p>Use <code>./laborejo --save</code> (see above). If you compiled without installing you can also run <code>./laborejo.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>./laborejo --save /tmp --mute</code></p> |
|||
|
|||
<p>Or even shorter:</p> |
|||
|
|||
<p><code>./laborejo -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> |
|||
|
|||
Loading…
Reference in new issue