Browse Source

Update documentation

master
Nils 3 years ago
parent
commit
2bece29e50
  1. 28
      README.md
  2. 35
      documentation/english.adoc
  3. 20
      documentation/german.adoc
  4. 4
      documentation/index.adoc
  5. 20
      documentation/out/german.html
  6. 2
      documentation/out/index.html

28
README.md

@ -1,5 +1,5 @@
#Laborejo
For program version 2.0 Beta 1
Program version 2.0
Laborejo (Esperanto: Workshop) is a MIDI sequencer based on classical music notation.
@ -19,7 +19,7 @@ This README is just a short introduction. Consult the manual (see below) for mor
# Contact and Information
* Website https://www.laborejo.org
* Documentation and Manual https://www.laborejo.org/documentation/laborejo2
* Documentation and Manual https://www.laborejo.org/documentation/laborejo
# Installation and Starting
@ -32,7 +32,7 @@ Download the latest code release on https://www.laborejo.org/downloads and extra
### Git Version
It is possible to clone a git repository.
`git clone --recurse-submodules https://laborejo.org/laborejo2.git`
`git clone --recurse-submodules https://laborejo.org/laborejo.git`
If you want to update at a later date you must use
@ -71,17 +71,17 @@ We make no distinction if you installed Laborejo yourself or through the distrib
The differences are: With or without NSM, with or without sound, installed or from the source dir.
### Installed with Non Session Manager (recommended)
Starting Laborejo through the Non Session Manager after you installed laborejo2 system-wide
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 `laborejo2`.
session. Then use the button "Add Client to Session" and type in `laborejo`.
It should appear with an icon in the list and open its GUI.
### Installed without NSM
If you start laborejo2 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 laborejo2 from a terminal (or create a starter script).
You can also start laborejo from a terminal (or create a starter script).
`laborejo2 --save DIRECTORY`
`laborejo --save DIRECTORY`
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).
@ -103,28 +103,28 @@ You can run Laborejo after extracting the release archive or cloning from git, w
* 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 https://github.com/kfoltman/calfbox
* Or you just run `./configure` and `make calfbox` without subsequent install, which creates a `site-packages` directory in the source dir.
* A third option is `laborejo2 --mute` which runs without sound at all and does not need calfbox.
* A third option is `laborejo --mute` which runs without sound at all and does not need calfbox.
### From source directory with NSM
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.
After extracting the release archive create a symlink from `laborejo2` into your PATH. e.g. /usr/bin
After extracting the release archive create a symlink from `laborejo` into your PATH. e.g. /usr/bin
or ~/bin, if that exists on your system.
If you compiled without installing you can also symlink to `./laborejo2.bin`
If you compiled without installing you can also symlink to `./laborejo.bin`
### From source dir without NSM
Use `./laborejo2 --save` (see above). If you compiled without installing you can also run `./laborejo2.bin`
Use `./laborejo --save` (see above). If you compiled without installing you can also run `./laborejo.bin`
### No NSM, no Make, No Sound
Combining the above options you can start the program directly after unpacking or cloning from git:
`./laborejo2 --save /tmp --mute`
`./laborejo --save /tmp --mute`
Or even shorter:
`./laborejo2 -s /tmp -m`
`./laborejo -s /tmp -m`
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.

35
documentation/english.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 2.0 Beta 1
:Version: 2.0
:iconfont-remote!:
:!webfonts:
@ -25,7 +25,22 @@ https://asciidoctor.org/docs/user-manual/
= Laborejo
// Don't write in the empty line above line. It will be interpreted as author html tag
For program version 2.0 Beta 1
For program version 2.0
== Introduction
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.
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!
Working in Laborejo is very fast and efficient by using a combination of midi input and typing.
== Usage
* Nothing
@ -39,30 +54,30 @@ For program version 2.0 Beta 1
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 available in the package repository, please continue reading directly at "Start laborejo2 from Non Session Manager".
If available in the package repository, please continue reading directly at "Start laborejo from Non Session Manager".
If not, you can build Laborejo yourself.
.Build and Install
* Please check the supplied README.md for dependencies.
* You can download a release or clone the git version
** Download the latest version from https://www.laborejo.org/downloads and extract it.
** `git clone https://laborejo.org/laborejo2.git`
** `git clone https://laborejo.org/laborejo.git`
* Change into the new directory and use these commands:
* `./configure --prefix=/usr`
** The default prefix is /usr/local
* `make`
* `sudo make install`
.Start laborejo2 from Non Session Manager (NSM)
.Start laborejo from Non Session Manager (NSM)
* Run `non-session-manager`
* Press the `New` button, and enter a name for your piece of music.
* Press the `Add Client to Session` button, enter `laborejo2` here, in lower case.
* Press the `Add Client to Session` button, enter `laborejo` here, in lower case.
* Add Client again, this time `jackpatch`.
* 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 laborejo2, 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.
== Help and Development
@ -90,7 +105,7 @@ However, here are the complete instructions for doing a translation completely o
The program is split in two parts. A shared "template" between the Laborejo Software Suite and the actual program.
The process is the same for both parts, but needs to be done in different directories:
`template/qtgui` and plain `/qtgui`, relative to the root directory, where the laborejo2 executable is.
`template/qtgui` and plain `/qtgui`, relative to the root directory, where the laborejo executable is.
Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Laborejo.
@ -115,6 +130,6 @@ You can also incorporate the translation into Laborejo for testing purposes. Thi
** To find out your language string (German, Esperanto etc.) open the `python3` interpreter in a terminal and run the following command:
** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`
To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start laborejo2 via the terminal:
To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start laborejo via the terminal:
* `LANGUAGE=de_DE.UTF-8 ./laborejo2 -V --save /dev/null`
* `LANGUAGE=de_DE.UTF-8 ./laborejo -V --save /dev/null`

20
documentation/german.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 2.0 Beta 1
:Version: 2.0
:iconfont-remote!:
:!webfonts:
@ -25,7 +25,7 @@ https://asciidoctor.org/docs/user-manual/
= Laborejo
// Don't write in the empty line above line. It will be interpreted as author html tag
Für Programmversion 2.0 Beta 1
Für Programmversion 2.0
== Bedienung
Hier gibt es nichts zu sehen.
@ -41,30 +41,30 @@ 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
Linuxdistribution Laborejo bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "laborejo2 im Non Session Manager starten" weiterlesen.
Falls in den Paketquellen vorhanden bitte direkt bei "laborejo im Non Session Manager starten" weiterlesen.
Falls nicht kann man Laborejo auch selbst "bauen".
.Abhängigkeiten*
* Eine Liste der Abhängigkeit befindet sich in der README.md
* 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.
** `git clone https://laborejo.org/laborejo2.git`
** `git clone https://laborejo.org/laborejo.git`
* Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:
*`./configure --prefix=/usr`
** Das Standardprefix is /usr/local
* `make`
* `sudo make install`
.laborejo2 im Non Session Manager (NSM) starten
.laborejo im Non Session Manager (NSM) starten
* Starten Sie `non-session-manager`
* Knopf `New`, geben Sie einen Namen für das Musikstück ein.
* Knopf `Add Client to Session`, geben Sie hier `laborejo2` ein, kleingeschrieben.
* Knopf `Add Client to Session`, geben Sie hier `laborejo` ein, kleingeschrieben.
* Nochmal Add Client, diesmal `jackpatch`.
* 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 laborejo2 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.
== Helfen und Entwicklung
@ -96,7 +96,7 @@ das Programm einzubinden. Das Programm ist in zwei Teile aufgeteilt: Ein gemeins
Der Übersetzungsprozess ist der gleiche für beide Teile, man muss ihn jedoch in unterschiedlichen
Verzeichnissen durchführen:
`template/qtgui` und nur `/qtgui`, relativ zum Stammverzeichnis, wo sich die ausführbare Datei
laborejo2 befindet.
laborejo befindet.
Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.
@ -124,6 +124,6 @@ Python Kentnisse nötig.
Um die neue Übersetzung zu testen starten Sie das Programm, falls ihr System bereits auf diese
Sprache eingstellt ist.
Ansonsten starten Sie laborejo2 mit diesem Befehl, Sprachcode ändern, vom Terminal aus:
Ansonsten starten Sie laborejo mit diesem Befehl, Sprachcode ändern, vom Terminal aus:
* `LANGUAGE=de_DE.UTF-8 ./laborejo2 -V`
* `LANGUAGE=de_DE.UTF-8 ./laborejo -V`

4
documentation/index.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 2.0 Beta 1
:Version: 2.0
:iconfont-remote!:
:!webfonts:
@ -21,7 +21,7 @@ https://asciidoctor.org/docs/user-manual/
== Laborejo Multi-Language Documentation
image::logo.png["logo", 320, 180]
For program version 2.0 Beta 1
For program version 2.0
This site is part of the https://www.laborejo.org[Laborejo Software Suite]

20
documentation/out/german.html

@ -464,7 +464,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Für Programmversion 2.0 Beta 1</p>
<p>Für Programmversion 2.0</p>
</div>
</div>
</div>
@ -495,7 +495,7 @@ Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten
Linuxdistribution Laborejo bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "laborejo2 im Non Session Manager starten" weiterlesen.
<p>Falls in den Paketquellen vorhanden bitte direkt bei "laborejo im Non Session Manager starten" weiterlesen.
Falls nicht kann man Laborejo auch selbst "bauen".</p>
</div>
<div class="ulist">
@ -512,7 +512,7 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
<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>
</li>
<li>
<p><code>git clone <a href="https://laborejo.org/laborejo2.git" class="bare">https://laborejo.org/laborejo2.git</a></code></p>
<p><code>git clone <a href="https://laborejo.org/laborejo.git" class="bare">https://laborejo.org/laborejo.git</a></code></p>
</li>
</ul>
</div>
@ -537,7 +537,7 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
</ul>
</div>
<div class="ulist">
<div class="title">laborejo2 im Non Session Manager (NSM) starten</div>
<div class="title">laborejo im Non Session Manager (NSM) starten</div>
<ul>
<li>
<p>Starten Sie <code>non-session-manager</code></p>
@ -546,7 +546,7 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
<p>Knopf <code>New</code>, geben Sie einen Namen für das Musikstück ein.</p>
</li>
<li>
<p>Knopf <code>Add Client to Session</code>, geben Sie hier <code>laborejo2</code> ein, kleingeschrieben.</p>
<p>Knopf <code>Add Client to Session</code>, geben Sie hier <code>laborejo</code> ein, kleingeschrieben.</p>
</li>
<li>
<p>Nochmal Add Client, diesmal <code>jackpatch</code>.</p>
@ -567,7 +567,7 @@ Falls nicht kann man Laborejo auch selbst "bauen".</p>
</ul>
</div>
<div class="paragraph">
<p>In der Datei README.md befinden sich weitere Möglichkeiten laborejo2 zu starten. Diese sind zum
<p>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.</p>
</div>
</div>
@ -627,7 +627,7 @@ das Programm einzubinden. Das Programm ist in zwei Teile aufgeteilt: Ein gemeins
<p>Der Übersetzungsprozess ist der gleiche für beide Teile, man muss ihn jedoch in unterschiedlichen
Verzeichnissen durchführen:
<code>template/qtgui</code> und nur <code>/qtgui</code>, relativ zum Stammverzeichnis, wo sich die ausführbare Datei
laborejo2 befindet.</p>
laborejo befindet.</p>
</div>
<div class="paragraph">
<p>Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.</p>
@ -704,12 +704,12 @@ Python Kentnisse nötig.</p>
<div class="paragraph">
<p>Um die neue Übersetzung zu testen starten Sie das Programm, falls ihr System bereits auf diese
Sprache eingstellt ist.
Ansonsten starten Sie laborejo2 mit diesem Befehl, Sprachcode ändern, vom Terminal aus:</p>
Ansonsten starten Sie laborejo mit diesem Befehl, Sprachcode ändern, vom Terminal aus:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>LANGUAGE=de_DE.UTF-8 ./laborejo2 -V</code></p>
<p><code>LANGUAGE=de_DE.UTF-8 ./laborejo -V</code></p>
</li>
</ul>
</div>
@ -719,7 +719,7 @@ Ansonsten starten Sie laborejo2 mit diesem Befehl, Sprachcode ändern, vom Termi
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-03 11:41:32 +0200
Last updated 2019-10-04 23:57:54 +0200
</div>
</div>
</body>

2
documentation/out/index.html

@ -448,7 +448,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="paragraph">
<p>For program version 2.0 Beta 1
<p>For program version 2.0
This site is part of the <a href="https://www.laborejo.org">Laborejo Software Suite</a></p>
</div>
<div class="paragraph">

Loading…
Cancel
Save