lss
/
Laborejo
1
0
Fork 0
Code Releases Activity
Browse Source

Update documentation and info files

master
Nils 5 years ago
parent
c16c97b944
commit
c9c3bfb632
6 changed files with 35 additions and 67 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 16
      README.md
  2. 11
      documentation/english.adoc
  3. 17
      documentation/german.adoc
  4. 6
      documentation/laborejo.1
  5. 23
      documentation/out/english.html
  6. 29
      documentation/out/german.html

16
README.md
View File

@ -1,5 +1,5 @@
[//]: # (Generated 2020-05-03T19:00:24.148947. Changes belong into template/documentation/readme.template) [//]: # (Generated 2020-06-19T21:39:22.203666. Changes belong into template/documentation/readme.template)
#Laborejo #Laborejo
Program version 2.0 Program version 2.0
@ -53,7 +53,7 @@ It is possible to clone a git repository.
### Environment: ### Environment:
* Jack Audio Connection Kit must be running * Jack Audio Connection Kit must be running
* Non Session Manager * Argodejo / New Session Manager ("NSM")
## Build ## Build
./configure --prefix=/usr/local ./configure --prefix=/usr/local
@ -68,15 +68,15 @@ system as you want.
We make no distinction if you installed Laborejo yourself or through the distributions package-manager. We make no distinction if you installed Laborejo yourself or through the distributions package-manager.
The differences are: With or without NSM, with or without sound, installed or from the source dir. The differences are: With or without Argodejo, with or without sound, installed or from the source dir.
### Installed with Non Session Manager (recommended) ### Installed , running through Argodejo (New Session Manager) (recommended)
Starting Laborejo through the Non Session Manager after you installed laborejo system-wide Starting Laborejo through Argodejo after you installed laborejo system-wide
is the recommended and only supported way. Start non-session-manager and load or create a new is the recommended and only supported way. Start argodejo and load or create a new
session. Then use the button "Add Client to Session" and type in `laborejo`. session. Then use the program launcher to add `laborejo`.
It should appear with an icon in the list and open its GUI. It should appear with an icon in the list and open its GUI.
### Installed without NSM ### Installed without Argodejo
If you start laborejo directly it will present you with a dialog to choose your session directory. If you start laborejo directly it will present you with a dialog to choose your session directory.
You can also start laborejo from a terminal (or create a starter script). You can also start laborejo from a terminal (or create a starter script).

11
documentation/english.adoc
View File

@ -54,7 +54,7 @@ Working in Laborejo is very fast and efficient by using a combination of midi in
Laborejo is exclusive for Linux. The best way to install is to use your package manager. Laborejo is exclusive for Linux. The best way to install is to use your package manager.
If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version. If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.
If available in the package repository, please continue reading directly at "Start laborejo from Non Session Manager". If available in the package repository, please continue reading directly at "Start laborejo from Argodejo / New Session Manager".
If not, you can build Laborejo yourself. If not, you can build Laborejo yourself.
.Build and Install .Build and Install
@ -68,14 +68,11 @@ If not, you can build Laborejo yourself.
* `make` * `make`
* `sudo make install` * `sudo make install`
.Start laborejo from Non Session Manager (NSM) .Start laborejo from Argodejo (New Session Manager, NSM)
* Run `non-session-manager` * Run `argodejo`
* Press the `New` button, and enter a name for your piece of music. * Press the `New` button, and enter a name for your piece of music.
* Press the `Add Client to Session` button, enter `laborejo` here, in lower case. * Use the launcher to add `laborejo` to the session.
* Add Client again, this time `jackpatch`.
* Add any compatible programs, e.g. synthesizers. * Add any compatible programs, e.g. synthesizers.
** See the list of NSM compatible programs: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
** And the NSM manual: http://non.tuxfamily.org/nsm/
Please read README.md for other ways of starting laborejo, which are impractical for actual use but can Please read README.md for other ways of starting laborejo, which are impractical for actual use but can
be helpful for testing and development. be helpful for testing and development.

17
documentation/german.adoc
View File

@ -1143,13 +1143,13 @@ Laborejo ist exklusiv für Linux. Am besten installieren Sie Laborejo über dein
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten sie ihre Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten sie ihre
Linuxdistribution Laborejo bereitzustellen. Linuxdistribution Laborejo bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "laborejo im Non Session Manager starten" weiterlesen. Falls in den Paketquellen vorhanden bitte direkt bei "laborejo in Argodejo (New Session Manager)" weiterlesen.
Falls nicht kann man Laborejo auch selbst "bauen". Falls nicht kann man Laborejo auch selbst "bauen".
.Abhängigkeiten* .Abhängigkeiten*
* Eine Liste der Abhängigkeit befindet sich in der README.md * Eine Liste der Abhängigkeit befindet sich in der README.md
* Kompilieren und Installieren geht entweder mit einem Releasedownload oder mit der Git-Version: * Kompilieren und Installieren geht entweder mit einem Releasedownload oder mit der Git-Version:
** Lade von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacke sie. ** Laden Sie von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacken Sie sie.
** `git clone https://git.laborejo.org/lss/laborejo.git` ** `git clone https://git.laborejo.org/lss/laborejo.git`
* Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle: * Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:
*`./configure --prefix=/usr` *`./configure --prefix=/usr`
@ -1157,14 +1157,11 @@ Falls nicht kann man Laborejo auch selbst "bauen".
* `make` * `make`
* `sudo make install` * `sudo make install`
.laborejo im Non Session Manager (NSM) starten .laborejo im Argodejo (New Session Manager, NSM) starten
* Starten Sie `non-session-manager` * Starten Sie `argodejo`
* Knopf `New`, geben Sie einen Namen für das Musikstück ein. * Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein.
* Knopf `Add Client to Session`, geben Sie hier `laborejo` ein, kleingeschrieben. * Benutzen Sie den Launcher um `laborejo` hinzuzufügen.
* Nochmal Add Client, diesmal `jackpatch`.
* Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer. * Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer.
** Siehe auch das NSM Handbuch: http://non.tuxfamily.org/nsm/
** Und die Liste der NSM kompatiblen Programme: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
In der Datei README.md befinden sich weitere Möglichkeiten laborejo zu starten. Diese sind zum In der Datei README.md befinden sich weitere Möglichkeiten laborejo zu starten. Diese sind zum
Musikmachen nicht praktikabel, aber nützlich für Tests und Entwicklung. Musikmachen nicht praktikabel, aber nützlich für Tests und Entwicklung.
@ -1214,7 +1211,7 @@ So fügt man eine neue Sprache hinzu:
* Wählen Sie die "Target Language", also Zielsprache, aus und benutzen das Programm um eine Übersetzung anzufertigen. * Wählen Sie die "Target Language", also Zielsprache, aus und benutzen das Programm um eine Übersetzung anzufertigen.
* Senden Sie uns bitte die .ts Datei, z.B. per E-Mail an info@laborejo.org (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten) * Senden Sie uns bitte die .ts Datei, z.B. per E-Mail an info@laborejo.org (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten)
Die Übersetzung können Sie auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Die Übersetzung können Sie auch selbst, zum Testen, einbinden. Dafür sind rudimentäre
Python Kentnisse nötig. Python Kentnisse nötig.
* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie die `.ts` Datei.* Bearbeiten Sie `template/qtgui/resources/resources.qrc` und kopieren die Zeile `<file>translations/de.qm</file>` . Dabei das Länderkürzel zum Neuen ändern. * Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie die `.ts` Datei.* Bearbeiten Sie `template/qtgui/resources/resources.qrc` und kopieren die Zeile `<file>translations/de.qm</file>` . Dabei das Länderkürzel zum Neuen ändern.

6
documentation/laborejo.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH LABOREJO "1" "May 2020" "Laborejo 2.0" "User Commands" .TH LABOREJO "1" "June 2020" "Laborejo 2.0" "User Commands"
.SH NAME .SH NAME
Laborejo - MIDI sequencer based on classical music notation Laborejo - MIDI sequencer based on classical music notation
.SH DESCRIPTION .SH DESCRIPTION
@ -17,7 +17,7 @@ show program's version number and exit
.TP .TP
\fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY \fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY
Use this directory to save. Will be created or loaded Use this directory to save. Will be created or loaded
from if already present. Deactivates Non\-SessionManager support. from if already present. Deactivates Argodejo/NewSession\-Manager support.
.TP .TP
\fB\-p\fR, \fB\-\-profiler\fR \fB\-p\fR, \fB\-\-profiler\fR
(Development) Run the python profiler and produce a (Development) Run the python profiler and produce a

23
documentation/out/english.html
View File

@ -513,7 +513,7 @@ maximum fine control to get exactly the music you want!</p>
If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.</p> If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.</p>
</div> </div>
<div class="paragraph"> <div class="paragraph">
<p>If available in the package repository, please continue reading directly at "Start laborejo from Non Session Manager". <p>If available in the package repository, please continue reading directly at "Start laborejo from Argodejo / New Session Manager".
If not, you can build Laborejo yourself.</p> If not, you can build Laborejo yourself.</p>
</div> </div>
<div class="ulist"> <div class="ulist">
@ -557,32 +557,19 @@ If not, you can build Laborejo yourself.</p>
</ul> </ul>
</div> </div>
<div class="ulist"> <div class="ulist">
<div class="title">Start laborejo from Non Session Manager (NSM)</div> <div class="title">Start laborejo from Argodejo (New Session Manager, NSM)</div>
<ul> <ul>
<li> <li>
<p>Run <code>non-session-manager</code></p> <p>Run <code>argodejo</code></p>
</li> </li>
<li> <li>
<p>Press the <code>New</code> button, and enter a name for your piece of music.</p> <p>Press the <code>New</code> button, and enter a name for your piece of music.</p>
</li> </li>
<li> <li>
<p>Press the <code>Add Client to Session</code> button, enter <code>laborejo</code> here, in lower case.</p> <p>Use the launcher to add <code>laborejo</code> to the session.</p>
</li>
<li>
<p>Add Client again, this time <code>jackpatch</code>.</p>
</li> </li>
<li> <li>
<p>Add any compatible programs, e.g. synthesizers.</p> <p>Add any compatible programs, e.g. synthesizers.</p>
<div class="ulist">
<ul>
<li>
<p>See the list of NSM compatible programs: <a href="http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm" class="bare">http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm</a></p>
</li>
<li>
<p>And the NSM manual: <a href="http://non.tuxfamily.org/nsm/" class="bare">http://non.tuxfamily.org/nsm/</a></p>
</li>
</ul>
</div>
</li> </li>
</ul> </ul>
</div> </div>
@ -733,7 +720,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2020-05-03 19:00:24 +0200 Last updated 2020-06-19 21:39:22 +0200
</div> </div>
</div> </div>
</body> </body>

29
documentation/out/german.html
View File

@ -2001,7 +2001,7 @@ Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten
Linuxdistribution Laborejo bereitzustellen.</p> Linuxdistribution Laborejo bereitzustellen.</p>
</div> </div>
<div class="paragraph"> <div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "laborejo im Non Session Manager starten" weiterlesen. <p>Falls in den Paketquellen vorhanden bitte direkt bei "laborejo in Argodejo (New Session Manager)" weiterlesen.
Falls nicht kann man Laborejo auch selbst "bauen".</p> Falls nicht kann man Laborejo auch selbst "bauen".</p>
</div> </div>
<div class="ulist"> <div class="ulist">
@ -2015,7 +2015,7 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
<div class="ulist"> <div class="ulist">
<ul> <ul>
<li> <li>
<p>Lade von <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> die aktuelle Version herunter und entpacke sie.</p> <p>Laden Sie von <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> die aktuelle Version herunter und entpacken Sie sie.</p>
</li> </li>
<li> <li>
<p><code>git clone <a href="https://git.laborejo.org/lss/laborejo.git" class="bare">https://git.laborejo.org/lss/laborejo.git</a></code></p> <p><code>git clone <a href="https://git.laborejo.org/lss/laborejo.git" class="bare">https://git.laborejo.org/lss/laborejo.git</a></code></p>
@ -2043,32 +2043,19 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
</ul> </ul>
</div> </div>
<div class="ulist"> <div class="ulist">
<div class="title">laborejo im Non Session Manager (NSM) starten</div> <div class="title">laborejo im Argodejo (New Session Manager, NSM) starten</div>
<ul> <ul>
<li> <li>
<p>Starten Sie <code>non-session-manager</code></p> <p>Starten Sie <code>argodejo</code></p>
</li> </li>
<li> <li>
<p>Knopf <code>New</code>, geben Sie einen Namen für das Musikstück ein.</p> <p>Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein.</p>
</li> </li>
<li> <li>
<p>Knopf <code>Add Client to Session</code>, geben Sie hier <code>laborejo</code> ein, kleingeschrieben.</p> <p>Benutzen Sie den Launcher um <code>laborejo</code> hinzuzufügen.</p>
</li>
<li>
<p>Nochmal Add Client, diesmal <code>jackpatch</code>.</p>
</li> </li>
<li> <li>
<p>Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer.</p> <p>Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer.</p>
<div class="ulist">
<ul>
<li>
<p>Siehe auch das NSM Handbuch: <a href="http://non.tuxfamily.org/nsm/" class="bare">http://non.tuxfamily.org/nsm/</a></p>
</li>
<li>
<p>Und die Liste der NSM kompatiblen Programme: <a href="http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm" class="bare">http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm</a></p>
</li>
</ul>
</div>
</li> </li>
</ul> </ul>
</div> </div>
@ -2181,7 +2168,7 @@ laborejo befindet.</p>
</ul> </ul>
</div> </div>
<div class="paragraph"> <div class="paragraph">
<p>Die Übersetzung können Sie auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre <p>Die Übersetzung können Sie auch selbst, zum Testen, einbinden. Dafür sind rudimentäre
Python Kentnisse nötig.</p> Python Kentnisse nötig.</p>
</div> </div>
<div class="ulist"> <div class="ulist">
@ -2231,7 +2218,7 @@ Ansonsten starten Sie laborejo mit diesem Befehl, Sprachcode ändern, vom Termin
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2020-05-03 19:00:24 +0200 Last updated 2020-06-19 21:39:22 +0200
</div> </div>
</div> </div>
</body> </body>

Write Preview
Loading…
Cancel
Save