From 2cac0f083ba1fe8e15ff6ef101169d585d755bb3 Mon Sep 17 00:00:00 2001
From: Nils <>
Date: Sun, 24 Mar 2019 12:25:11 +0100
Subject: [PATCH] Update documentation
---
README.md | 131 ++++++
documentation/english.adoc | 120 +++++
documentation/german.adoc | 147 +++++++
documentation/index.adoc | 30 ++
documentation/out/german.html | 793 ++++++++++++++++++++++++++++++++++
documentation/out/index.html | 462 ++++++++++++++++++++
index.html | 173 ++++++++
7 files changed, 1856 insertions(+)
create mode 100644 README.md
create mode 100644 documentation/english.adoc
create mode 100644 documentation/german.adoc
create mode 100644 documentation/index.adoc
create mode 100644 documentation/out/german.html
create mode 100644 documentation/out/index.html
create mode 100644 index.html
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c3cf67
--- /dev/null
+++ b/README.md
@@ -0,0 +1,131 @@
+#Laborejo
+For program version 2.0
+
+
+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 within 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.
+
+This README is just a short introduction. Consult the manual (see below) for more information.
+
+# Contact and Information
+
+* Website https://www.laborejo.org
+* Documentation and Manual https://www.laborejo.org/documentation/laborejo2
+
+# Installation and Starting
+
+## Download
+
+### Release Version
+If the latest release is not available through your package manger you can build it yourself:
+Download the latest code release on https://www.laborejo.org/downloads and extract it.
+
+### Git Version
+It is possible to clone a git repository.
+
+`git clone --recurse-submodules https://laborejo.org/laborejo2.git`
+
+If you want to update at a later date you must use
+
+`git pull --recurse-submodules`
+
+
+## Dependencies
+* Glibc
+* Python 3.6 (maybe earlier)
+* PyQt5 for Python 3
+* DejaVu Sans Sarif TTF (Font) (recommended, but not technically necessary)
+* A Brain
+* Linux
+
+#### Build Dependencies
+* Bash
+* Nuitka >= 0.6 (maybe earlier. Optional when running from source dir)
+* GCC (development is done on 8.2, but most likely you can use a much earlier version)
+
+### Environment:
+* Jack Audio Connection Kit must be running
+* Non Session Manager
+
+## Build
+ ./configure --prefix=/usr/local
+ make
+ sudo make install
+
+
+## Starting
+
+There are multiple ways to run Laborejo which should give you the flexibility to configure your
+system as you want.
+
+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 permutations are too many to describe them all in detail, but here are some useful modes:
+
+### Installed with Non Session Manager (recommended)
+Starting Laborejo through the Non Session Manager after you installed laborejo2 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`.
+It should appear with an icon in the list and open its GUI.
+
+### Installed without NSM
+You need to start laborejo2 from a terminal (or create a starter script).
+
+`laborejo2 --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).
+
+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.
+
+Sending SIGUSR1 to the program in this mode will trigger a save.
+
+Closing through your window manager in this mode will actually quit the application without a
+prompt to save changes.
+
+## From source directory
+You can run Laborejo after extracting the release archive or cloning from git, without installation.
+
+### Calfbox
+"Calfbox" is the name of our internal realtime midi/audio python module.
+
+* 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.
+
+### 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
+or ~/bin, if that exists on your system.
+
+If you compiled without installing you can also symlink to `./laborejo2.bin`
+
+### From source dir without NSM
+Use `./laborejo2 --save` (see above). If you compiled without installing you can also run `./laborejo2.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`
+
+Or even shorter:
+
+`./laborejo2 -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.
+
diff --git a/documentation/english.adoc b/documentation/english.adoc
new file mode 100644
index 0000000..5894d2d
--- /dev/null
+++ b/documentation/english.adoc
@@ -0,0 +1,120 @@
+:Author: Laborejo Software Suite
+:Version: 2.0
+:iconfont-remote!:
+:!webfonts:
+
+
+////
+This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
+To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
+letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+A copy of the license has been provided in the file documentation/LICENSE.
+////
+
+////
+https://powerman.name/doc/asciidoc
+https://asciidoctor.org/docs/user-manual/
+////
+
+:sectnums:
+
+:toc: left
+:toc-title: Table of Contents
+:toclevels: 3
+
+= Laborejo
+
+// Don't write in the empty line above line. It will be interpreted as author html tag
+For program version 2.0
+
+== Usage
+* Nothing
+* To
+* See
+* Here
+
+
+== Installation and Start
+
+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 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`
+* 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)
+* 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.
+* 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
+be helpful for testing and development.
+
+== Help and Development
+You can help Laborejo in several ways: Testing and reporting errors, translating, marketing, support, programming and more.
+
+=== Testing and Reporting Errors
+If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
+We are thankful for any help.
+
+.How to contact us
+* Website: https://www.laborejo.org
+* E-Mail: info@laborejo.org
+* IRC: #laborejo on server irc.freenode.org
+* If you see the opportunity and know that a developer will read it also forums, social media etc..
+
+=== Programming
+If you want to do some programming and don't know where to start please get in contact with us directly.
+The short version is: clone the git, change the code, create a git patch or point me to your public git.
+
+=== Translations
+Laborejo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
+The easiest way is to contact the developers and they will setup the new language.
+
+However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.
+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.
+
+Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Laborejo.
+
+You can add a new language like this:
+
+* Open a terminal and navigate to template/qtgui/resources/translations
+* Edit the file `config.pro` with a text editor
+ ** Append the name of your language in the last line, in the form `XY.ts`, where XY is the language code.
+ ** Make sure to leave a space between the individual languages entries.
+* Run `sh update.sh` in the same directory
+ ** The program has now generated a new `.ts` file in the same directory.
+* Start Qt Linguist with `linguist-qt5` (may be named differently) and open your newly generated file
+* Select your "Target Language" and use the program to create a translation
+* Send us the `.ts` file, such as by e-mail to info@laborejo.org (see below for more contact options)
+
+You can also incorporate the translation into Patroneo for testing purposes. This requires rudimentary Python knowledge.
+
+* Run the "Release" option in QtLinguists "File" menu. It creates a `.qm` file in the same directory as your `.ts` file.
+* Edit `template/qtgui/resources/resources.qrc` and duplicate the line `translations/de.qm` but change it to your new .qm file.
+* run `sh buildresources.sh`
+* Edit `engine/config.py`: add your language to the line that begins with "supportedLanguages" like this: `{"German": "de.qm", "Esperanto: "eo.qm"}`
+ ** 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:
+
+* `LANGUAGE=de_DE.UTF-8 ./laborejo2 -V --save /dev/null`
diff --git a/documentation/german.adoc b/documentation/german.adoc
new file mode 100644
index 0000000..c879a4c
--- /dev/null
+++ b/documentation/german.adoc
@@ -0,0 +1,147 @@
+:Author: Laborejo Software Suite
+:Version: 2.0
+:iconfont-remote!:
+:!webfonts:
+
+
+////
+This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
+To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
+letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+A copy of the license has been provided in the file documentation/LICENSE.
+////
+
+////
+https://powerman.name/doc/asciidoc
+https://asciidoctor.org/docs/user-manual/
+////
+
+:sectnums:
+
+:toc: left
+:toc-title: Inhaltsverzeichnis
+:toclevels: 3
+
+= Laborejo
+
+// Don't write in the empty line above line. It will be interpreted as author html tag
+Für Programmversion 2.0
+
+== Bedienung
+Hier gibt es nichts zu sehen.
+
+* Weiter
+* Gehen
+
+
+
+== Installation und Start
+
+Laborejo ist exklusiv für Linux. Am besten installierst du Laborejo über deinen Paketmanager.
+Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Laborejo bereitzustellen.
+
+Falls in den Paketquellen vorhanden bitte direkt bei "laborejo2 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`
+* Wechsele in das neue Verzeichnis und benutze diese Befehle:
+*`./configure --prefix=/usr`
+ ** Das Standardprefix is /usr/local
+* `make`
+* `sudo make install`
+
+.laborejo2 im Non Session Manager (NSM) starten
+* Starte `non-session-manager`
+* Knopf `New`, gib einen Namen für dein Musikstück ein.
+* Knopf `Add Client to Session`, gib hier `laborejo2` ein, kleingeschrieben.
+* Nochmal Add Client, diesmal `jackpatch`.
+* Füge 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 Musikmachen nicht praktikabel,
+aber nützlich für Tests und Entwicklung.
+
+== Helfen und Entwicklung
+Du kannst Laborejo in vielen Art helfen: Testen und Fehler melden, übersetzen, marketing, anderen Nutzern helfen und schließlich programmieren.
+
+=== Testen und Programmfehler
+Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf eine Art und Weise, die dir am besten passt.
+
+.Kontaktmöglichkeiten
+* Webseite: https://www.laborejo.org
+* E-Mail: info@laborejo.org
+* IRC: #laborejo auf dem Server irc.freenode.org
+* Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Socialmedia etc.
+
+== Entwicklung
+Falls du an der Entwicklung interessiert bist melde dich am besten direkt bei uns (s.o.)
+Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns deine git URL zukommen lassen.
+
+=== Übersetzungen
+Laborejo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
+Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrichten.
+
+Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
+
+* Öffne ein Terminal und navigiere ins Patroneo Verzeichnis
+* Im Patroneo Verzeichnis: `cd gui/translations`
+* Bearbeite die Datei `config.pro` mit einem Texteditor
+ ** Hänge in der 2. Zeile den Namen deiner Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
+ ** Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
+* Führe `pylupdate5 config.pro` aus.
+ ** Das Programm hat nun eine neue `.ts` Datei im `translations` Verzeichnis generiert
+* Starte Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
+* Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
+* Sende uns 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 kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
+
+* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie deine `.ts` Datei.
+* Öffne die `patroneo` Starterdatei im Texteditor
+ ** Scrolle nach ganz unten, dort wird die Sprache eingestellt.
+ ** Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile `#print (language)`. Starte NSM aus einem Terminal, starte Patroneo und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)
+ ** Am Ende der Datei ist ein Dictionary `supportedLanguages`. Füge deine Sprache hinzu. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
+
+
+=== Übersetzungen
+Laborejo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
+Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrich
+
+Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
+Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle Laborejo Software Suit Programme) sowie das eigentliche Programm.
+
+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.
+
+Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.
+
+So fügt man eine neue Sprache hinzu:
+
+* Öffne ein Terminal und navigiere zu template/qtgui/resources/translations
+* Bearbeite die Datei `config.pro` in einem Texteditor.
+ ** Hänge in der letzten Zeile den Namen deiner Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
+ ** Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
+* Führe `sh update.sh` im selben Verzeichnis aus.
+ ** Das Programm hat nun eine neue `.ts`-Datei im Verzeichnis erstellt.
+* Starte Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
+* Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
+* Sende uns 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 kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
+
+* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie deine `.ts` Datei.
+* Bearbeite `template/qtgui/resources/resources.qrc` kopiere die Zeile `translations/de.qm` , aber änder das Länderkürzel zu deinem neuen.
+* Führe `sh buildresources.sh` aus
+* Bearbeite `engine/config.py`: Füge deine Sprache hinzu. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
+ ** Um deinen Sprachstring herauszufinden öffne den `python3`-Interpreter im Terminal und führe aus:
+ ** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`
+
+
+Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte laborejo2 mit diesem Befehl vom Terminal aus:
+
+* `LANGUAGE=de_DE.UTF-8 ./laborejo2 -V --save /dev/null`
diff --git a/documentation/index.adoc b/documentation/index.adoc
new file mode 100644
index 0000000..078d8bd
--- /dev/null
+++ b/documentation/index.adoc
@@ -0,0 +1,30 @@
+:Author: Laborejo Software Suite
+:Version: 2.0
+:iconfont-remote!:
+:!webfonts:
+
+////
+This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
+To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
+letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+A copy of the license has been provided in the file documentation/LICENSE.
+////
+
+////
+https://powerman.name/doc/asciidoc
+https://asciidoctor.org/docs/user-manual/
+////
+
+:nofooter:
+
+
+== Laborejo Multi-Language Documentation
+For program version 2.0
+
+This site is part of the https://www.laborejo.org[Laborejo Software Suite]
+
+
+Please choose a language
+
+* link:english.html[English]
+* link:german.html[Deutsch (German)]
diff --git a/documentation/out/german.html b/documentation/out/german.html
new file mode 100644
index 0000000..48e41c0
--- /dev/null
+++ b/documentation/out/german.html
@@ -0,0 +1,793 @@
+
+
+
Laborejo ist exklusiv für Linux. Am besten installierst du Laborejo über deinen Paketmanager.
+Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Laborejo bereitzustellen.
+
+
+
Falls in den Paketquellen vorhanden bitte direkt bei "laborejo2 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:
In der Datei README.md befinden sich weitere Möglichkeiten laborejo2 zu starten. Diese sind zum Musikmachen nicht praktikabel,
+aber nützlich für Tests und Entwicklung.
+
+
+
+
+
3. Helfen und Entwicklung
+
+
+
Du kannst Laborejo in vielen Art helfen: Testen und Fehler melden, übersetzen, marketing, anderen Nutzern helfen und schließlich programmieren.
+
+
+
3.1. Testen und Programmfehler
+
+
Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf eine Art und Weise, die dir am besten passt.
Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Socialmedia etc.
+
+
+
+
+
+
+
+
4. Entwicklung
+
+
+
Falls du an der Entwicklung interessiert bist melde dich am besten direkt bei uns (s.o.)
+Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns deine git URL zukommen lassen.
+
+
+
4.1. Übersetzungen
+
+
Laborejo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
+Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrichten.
+
+
+
Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
+
+
+
+
+
Öffne ein Terminal und navigiere ins Patroneo Verzeichnis
+
+
+
Im Patroneo Verzeichnis: cd gui/translations
+
+
+
Bearbeite die Datei config.pro mit einem Texteditor
+
+
+
+
Hänge in der 2. Zeile den Namen deiner Sprache an, in der Form XY.ts, wobei XY der Sprachcode ist.
+
+
+
Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
+
+
+
+
+
+
Führe pylupdate5 config.pro aus.
+
+
+
+
Das Programm hat nun eine neue .ts Datei im translations Verzeichnis generiert
+
+
+
+
+
+
Starte Qt Linguist mit linguist-qt5 (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
+
+
+
Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
+
+
+
Sende uns 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 kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
+
+
+
+
+
Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine .qm Datei im gleichen Verzeichnis wie deine .ts Datei.
+
+
+
Öffne die patroneo Starterdatei im Texteditor
+
+
+
+
Scrolle nach ganz unten, dort wird die Sprache eingestellt.
+
+
+
Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile #print (language). Starte NSM aus einem Terminal, starte Patroneo und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)
+
+
+
Am Ende der Datei ist ein Dictionary supportedLanguages. Füge deine Sprache hinzu. z.B. {"German":"de.qm", "Esperanto:"eo.qm"}
+
+
+
+
+
+
+
+
+
4.2. Übersetzungen
+
+
Laborejo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
+Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrich
+
+
+
Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
+Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle Laborejo Software Suit Programme) sowie das eigentliche Programm.
+
+
+
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.
+
+
+
Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.
+
+
+
So fügt man eine neue Sprache hinzu:
+
+
+
+
+
Öffne ein Terminal und navigiere zu template/qtgui/resources/translations
+
+
+
Bearbeite die Datei config.pro in einem Texteditor.
+
+
+
+
Hänge in der letzten Zeile den Namen deiner Sprache an, in der Form XY.ts, wobei XY der Sprachcode ist.
+
+
+
Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
+
+
+
+
+
+
Führe sh update.sh im selben Verzeichnis aus.
+
+
+
+
Das Programm hat nun eine neue .ts-Datei im Verzeichnis erstellt.
+
+
+
+
+
+
Starte Qt Linguist mit linguist-qt5 (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
+
+
+
Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
+
+
+
Sende uns 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 kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
+
+
+
+
+
Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine .qm Datei im gleichen Verzeichnis wie deine .ts Datei.
+
+
+
Bearbeite template/qtgui/resources/resources.qrc kopiere die Zeile <file>translations/de.qm</file> , aber änder das Länderkürzel zu deinem neuen.
+
+
+
Führe sh buildresources.sh aus
+
+
+
Bearbeite engine/config.py: Füge deine Sprache hinzu. z.B. {"German":"de.qm", "Esperanto:"eo.qm"}
+
+
+
+
Um deinen Sprachstring herauszufinden öffne den python3-Interpreter im Terminal und führe aus:
+
+
+
from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())
+
+
+
+
+
+
+
+
Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte laborejo2 mit diesem Befehl vom Terminal aus:
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..a6e483a
--- /dev/null
+++ b/index.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+
+ Laborejo: Git Readme
+
+
+
+
+
Laborejo
+
+
For program version 2.0
+
+
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 within 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.
+
+
This README is just a short introduction. Consult the manual (see below) for more information.
If the latest release is not available through your package manger you can build it yourself:
+Download the latest code release on https://www.laborejo.org/downloads and extract it.
If you want to update at a later date you must use
+
+
git pull --recurse-submodules
+
+
Dependencies
+
+
+
Glibc
+
Python 3.6 (maybe earlier)
+
PyQt5 for Python 3
+
DejaVu Sans Sarif TTF (Font) (recommended, but not technically necessary)
+
A Brain
+
Linux
+
+
+
+
Build Dependencies
+
+
+
Bash
+
Nuitka >= 0.6 (maybe earlier. Optional when running from source dir)
+
GCC (development is done on 8.2, but most likely you can use a much earlier version)
+
+
+
+
Environment:
+
+
+
Jack Audio Connection Kit must be running
+
Non Session Manager
+
+
+
+
Build
+
+
./configure --prefix=/usr/local
+make
+sudo make install
+
+
+
Starting
+
+
There are multiple ways to run Laborejo which should give you the flexibility to configure your
+system as you want.
+
+
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 permutations are too many to describe them all in detail, but here are some useful modes:
+
+
Installed with Non Session Manager (recommended)
+
+
Starting Laborejo through the Non Session Manager after you installed laborejo2 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.
+It should appear with an icon in the list and open its GUI.
+
+
Installed without NSM
+
+
You need to start laborejo2 from a terminal (or create a starter script).
+
+
laborejo2 --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).
+
+
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.
+
+
Sending SIGUSR1 to the program in this mode will trigger a save.
+
+
Closing through your window manager in this mode will actually quit the application without a
+prompt to save changes.
+
+
From source directory
+
+
You can run Laborejo after extracting the release archive or cloning from git, without installation.
+
+
Calfbox
+
+
“Calfbox” is the name of our internal realtime midi/audio python module.
+
+
+
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.
+
+
+
+
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
+or ~/bin, if that exists on your system.
+
+
If you compiled without installing you can also symlink to ./laborejo2.bin
+
+
From source dir without NSM
+
+
Use ./laborejo2 --save (see above). If you compiled without installing you can also run ./laborejo2.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
+
+
Or even shorter:
+
+
./laborejo2 -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.