Browse Source

prepare docs for new template system

master
Nils 5 years ago
parent
commit
3341228874
  1. 93
      documentation/english.part.adoc
  2. 96
      documentation/german.part.adoc

93
documentation/english.adoc → documentation/english.part.adoc

@ -1,60 +1,9 @@
:Author: Nils Hilbricht
:Version: 1.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
== Patroneo User Manual
== Usage
We are happy you chose Patroneo. Patroneo is an easy-to-use sequencer, a program that sends digital "notes" to software instruments such as synthesizers and samplers.
Patroneo means "pattern" in Esperanto. The reason for this is that you don't put single notes in a row but build whole measures, which you can repeat - or leave out - at any place.
== Installation and Starting
Patroneo is exclusive for Linux. The best way to install Patroneo 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 Patroneo from Non Session Manager".
If not, you can build Patroneo yourself.
.Dependencies
* First install the packages Python3, PyQt5, Nuitka and GCC.
* And these audio packages: Jack Audio Connection Kit, QJackCtl (or something else to establish Jack connections), Non Session Manager
* Build and Install:
** Download the latest version from https://www.laborejo.org/downloads and extract it.
** Cd into the new directory and use these commands:
** `./configure`
** `make`
** `sudo make install`
.Start Patroneo 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 `patroneo` 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/
== How to use Patroneo
The following explains how to use Patroneo.
@ -248,43 +197,3 @@ For all other transformations it depends on whether the existing tones lie betwe
** Impossible positions are moved to the next possible position. In any case, this means that the music now sounds different. Usually several notes are pushed on top of each other and form chords.
With a little experience you will be able to estimate what error handling you need.
== Development
The further development of Patroneo will consist of improvements in the areas of stability and program performance.
New functions are not categorically excluded, but are only possible after long-term observation of user behaviour.
=== Translations
Patroneo 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.
* Open a terminal and navigate to the Patroneo directory
* In the Patroneo directory: `cd gui/translations`
* Edit the file `config.pro` with a text editor
** Append the name of your language in the 2nd line, in the form `tXY.ts`, where XY is the language code.
** Make sure to leave a space between the individual languages entries.
* Run `pylupdate5 config.pro`
** The program has now generated a new `.ts` file in the `translations` subdirectory
* 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.
* In the Qt Linguist "File" menu is a "Release" option. This creates a `.qm` file in the same directory as your `.ts` file.
* Open the `patroneo` starter file in your text editor
** Scroll down to the bottom to set the language.
** To find out your language string (German, Esperanto etc.) remove the # hash from the existing line `#print (language)`. Start NSM from a terminal, start Patroneo and the language string will be printed there (you have to search a bit)
** At the end of the file is a dictionary `supportedLanguages`. Add your language. For example `{"German": "de.qm", "Esperanto: "eo.qm"}`
=== Bugs
If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
.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, Facebook etc..

96
documentation/german.adoc → documentation/german.part.adoc

@ -1,60 +1,9 @@
:Author: Nils Hilbricht
:Version: 1.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
== Patroneo Bedienungsanleitung
== Benutzung
Schön, dass du dich für Patroneo entschieden hast. Patroneo ist ein leicht zu bedienender "Sequencer", also ein Programm, dass digitale "Noten" an Softwareinstrumente, wie Synthesizer und Sampler, schickt.
"Patroneo" heißt "Muster" auf Esperanto. Das kommt daher, dass man hier nicht einzelne Noten hintereinander setzt sondern ganze Takte baut, die man dann beliebig oft an beliebigen Stellen wiederholen - oder auslassen - kann.
== Installation und Start
Patroneo ist exklusiv für Linux. Am besten installierst du Patroneo über deinen Paketmanager. Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Patroneo bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "Patroneo im Non Session Manager starten" weiterlesen.
Falls nicht kann man Patroneo auch selbst "bauen".
.Abhängigkeiten
* Installiere zunächst die Pakete Python3, PyQt5, Nuitka und GCC.
* Und diese Audiopakete: Jack Audio Connection Kit, QJackCtl (oder etwas anderes um Jack Verbindungen herzustellen), Non Session Manager
* Kompilieren und Installieren:
** Lade von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacke sie.
** Wechsele in das neue Verzeichnis und benutze diese Befehle:
** `./configure`
** `make`
** `sudo make install`
.Patroneo 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 `patroneo` 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
== Bedienung
Im folgenden wird erklärt, wie Patroneo bedient wird.
@ -252,46 +201,3 @@ Bei allen anderen Umgruppierungen kommt es darauf an, ob die vorhandenen Töne n
** Unmögliche Positionen werden auf die nächstmögliche Position geschoben. Dies führt in jedem Fall dazu, dass die Musik nun anders klingt. Meist werden dadurch mehrere Noten übereinander geschoben und bilden Akkorde.
Mit ein wenig Erfahrung wird man abschätzen können, was man braucht.
== Entwicklung
Die weitere Entwicklung Patroneos besteht aus der Verbesserung in den Bereichen Stabilität und Programmgeschwindigkeit.
Neue Funktionen werden zwar nicht kategorisch ausgeschlossen, sind aber erst nach Langzeitbeobachtung des Nutzerverhaltens möglich.
=== Übersetzungen
Patroneo 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"}`
=== Bugs und Programmfehler
Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf die 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, Facebook etc.
Loading…
Cancel
Save