Browse Source

Update documentation

Former-commit-id: 03e8747115aea1099369da8d9cc4acbe12e82e20
master
Nils 4 years ago
parent
commit
a62d1054f3
  1. 2
      README.md
  2. 17
      documentation/english.adoc
  3. 16
      documentation/german.adoc
  4. 24
      documentation/out/english.html
  5. 18
      documentation/out/german.html

2
README.md

@ -44,9 +44,9 @@ You will not be able to push your changes.
* Nuitka >= 0.6 (maybe earlier)
* 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
The default prefix is /usr/local

17
documentation/english.adoc

@ -90,30 +90,30 @@ The current visibility setting is saved. This is because you normally only spend
Fluajho 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 <shortname> from Non Session Manager".
If available in the package repository, please continue reading directly at "Start fluajho from Non Session Manager".
If not, you can build Fluajho 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/<shortname>.git`
** `git clone https://laborejo.org/fluajho.git`
* Change into the new directory and use these commands:
* `./configure --prefix=/usr`
** The default prefix is /usr/local
* `make`
* `sudo make install`
.Start <shortname> from Non Session Manager (NSM)
.Start fluajho 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 `<shortname>` here, in lower case.
* Press the `Add Client to Session` button, enter `fluajho` 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 <shortname>, which are impractical for actual use but can
Please read README.md for other ways of starting fluajho, which are impractical for actual use but can
be helpful for testing and development.
== Help and Development
@ -141,7 +141,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 <shortname> executable is.
`template/qtgui`and plain `/qtgui`, relative to the root directory, where the fluajho executable is.
Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Fluajho.
@ -166,5 +166,6 @@ You can also incorporate the translation into Patroneo 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 <shortname> via the terminal:
* `LANGUAGE=de_DE.UTF-8 ./<shortname> -V --save /dev/null`
To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start fluajho via the terminal:
* `LANGUAGE=de_DE.UTF-8 ./fluajho -V --save /dev/null`

16
documentation/german.adoc

@ -89,30 +89,30 @@ Die momentane Sichtbarkeitseinstellung wird gespeichert. Das hat den Grund, dass
Fluajho ist exklusiv für Linux. Am besten installierst du Fluajho über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Fluajho bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "<shortname> im Non Session Manager starten" weiterlesen.
Falls in den Paketquellen vorhanden bitte direkt bei "fluajho im Non Session Manager starten" weiterlesen.
Falls nicht kann man Fluajho 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/<shortname>.git`
** `git clone https://laborejo.org/fluajho.git`
* Wechsele in das neue Verzeichnis und benutze diese Befehle:
*`./configure --prefix=/usr`
** Das Standardprefix is /usr/local
* `make`
* `sudo make install`
.<shortname> im Non Session Manager (NSM) starten
.fluajho 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 `<shortname>` ein, kleingeschrieben.
* Knopf `Add Client to Session`, gib hier `fluajho` 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 <shortname> zu starten. Diese sind zum Musikmachen nicht praktikabel,
In der Datei README.md befinden sich weitere Möglichkeiten fluajho zu starten. Diese sind zum Musikmachen nicht praktikabel,
aber nützlich für Tests und Entwicklung.
== Helfen und Entwicklung
@ -165,7 +165,7 @@ Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine
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 <shortname> befindet.
`template/qtgui` und nur `/qtgui`, relativ zum Stammverzeichnis, wo sich die ausführbare Datei fluajho befindet.
Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.
@ -191,6 +191,6 @@ Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafü
** `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 <shortname> mit diesem Befehl vom Terminal aus:
Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte fluajho mit diesem Befehl vom Terminal aus:
* `LANGUAGE=de_DE.UTF-8 ./<shortname> -V --save /dev/null`
* `LANGUAGE=de_DE.UTF-8 ./fluajho -V --save /dev/null`

24
documentation/out/english.html

@ -568,7 +568,7 @@ The current visibility setting is saved. This is because you normally only spend
If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.</p>
</div>
<div class="paragraph">
<p>If available in the package repository, please continue reading directly at "Start &lt;shortname&gt; from Non Session Manager".
<p>If available in the package repository, please continue reading directly at "Start fluajho from Non Session Manager".
If not, you can build Fluajho yourself.</p>
</div>
<div class="ulist">
@ -585,7 +585,7 @@ If not, you can build Fluajho yourself.</p>
<p>Download the latest version from <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> and extract it.</p>
</li>
<li>
<p><code>git clone <a href="https://laborejo.org/&lt;shortname&gt;.git" class="bare">https://laborejo.org/&lt;shortname&gt;.git</a></code></p>
<p><code>git clone <a href="https://laborejo.org/fluajho.git" class="bare">https://laborejo.org/fluajho.git</a></code></p>
</li>
</ul>
</div>
@ -612,7 +612,7 @@ If not, you can build Fluajho yourself.</p>
</ul>
</div>
<div class="ulist">
<div class="title">Start &lt;shortname&gt; from Non Session Manager (NSM)</div>
<div class="title">Start fluajho from Non Session Manager (NSM)</div>
<ul>
<li>
<p>Run <code>non-session-manager</code></p>
@ -621,7 +621,7 @@ If not, you can build Fluajho yourself.</p>
<p>Press the <code>New</code> button, and enter a name for your piece of music.</p>
</li>
<li>
<p>Press the <code>Add Client to Session</code> button, enter <code>&lt;shortname&gt;</code> here, in lower case.</p>
<p>Press the <code>Add Client to Session</code> button, enter <code>fluajho</code> here, in lower case.</p>
</li>
<li>
<p>Add Client again, this time <code>jackpatch</code>.</p>
@ -642,7 +642,7 @@ If not, you can build Fluajho yourself.</p>
</ul>
</div>
<div class="paragraph">
<p>Please read README.md for other ways of starting &lt;shortname&gt;, which are impractical for actual use but can
<p>Please read README.md for other ways of starting fluajho, which are impractical for actual use but can
be helpful for testing and development.</p>
</div>
</div>
@ -696,7 +696,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div class="paragraph">
<p>The process is the same for both parts, but needs to be done in different directories:
<code>template/qtgui`and plain `/qtgui</code>, relative to the root directory, where the &lt;shortname&gt; executable is.</p>
<code>template/qtgui`and plain `/qtgui</code>, relative to the root directory, where the fluajho executable is.</p>
</div>
<div class="paragraph">
<p>Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Fluajho.</p>
@ -773,8 +773,14 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</ul>
</div>
<div class="paragraph">
<p>To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start &lt;shortname&gt; via the terminal:
* <code>LANGUAGE=de_DE.UTF-8 ./&lt;shortname&gt; -V --save /dev/null</code></p>
<p>To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start fluajho via the terminal:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>LANGUAGE=de_DE.UTF-8 ./fluajho -V --save /dev/null</code></p>
</li>
</ul>
</div>
</div>
</div>
@ -782,7 +788,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-26 18:51:45 +0100
Last updated 2019-01-26 18:52:51 +0100
</div>
</div>
</body>

18
documentation/out/german.html

@ -572,7 +572,7 @@ Die momentane Sichtbarkeitseinstellung wird gespeichert. Das hat den Grund, dass
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Fluajho bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "&lt;shortname&gt; im Non Session Manager starten" weiterlesen.
<p>Falls in den Paketquellen vorhanden bitte direkt bei "fluajho im Non Session Manager starten" weiterlesen.
Falls nicht kann man Fluajho auch selbst "bauen".</p>
</div>
<div class="ulist">
@ -589,7 +589,7 @@ Falls nicht kann man Fluajho 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/&lt;shortname&gt;.git" class="bare">https://laborejo.org/&lt;shortname&gt;.git</a></code></p>
<p><code>git clone <a href="https://laborejo.org/fluajho.git" class="bare">https://laborejo.org/fluajho.git</a></code></p>
</li>
</ul>
</div>
@ -614,7 +614,7 @@ Falls nicht kann man Fluajho auch selbst "bauen".</p>
</ul>
</div>
<div class="ulist">
<div class="title">&lt;shortname&gt; im Non Session Manager (NSM) starten</div>
<div class="title">fluajho im Non Session Manager (NSM) starten</div>
<ul>
<li>
<p>Starte <code>non-session-manager</code></p>
@ -623,7 +623,7 @@ Falls nicht kann man Fluajho auch selbst "bauen".</p>
<p>Knopf <code>New</code>, gib einen Namen für dein Musikstück ein.</p>
</li>
<li>
<p>Knopf <code>Add Client to Session</code>, gib hier <code>&lt;shortname&gt;</code> ein, kleingeschrieben.</p>
<p>Knopf <code>Add Client to Session</code>, gib hier <code>fluajho</code> ein, kleingeschrieben.</p>
</li>
<li>
<p>Nochmal Add Client, diesmal <code>jackpatch</code>.</p>
@ -644,7 +644,7 @@ Falls nicht kann man Fluajho auch selbst "bauen".</p>
</ul>
</div>
<div class="paragraph">
<p>In der Datei README.md befinden sich weitere Möglichkeiten &lt;shortname&gt; zu starten. Diese sind zum Musikmachen nicht praktikabel,
<p>In der Datei README.md befinden sich weitere Möglichkeiten fluajho zu starten. Diese sind zum Musikmachen nicht praktikabel,
aber nützlich für Tests und Entwicklung.</p>
</div>
</div>
@ -777,7 +777,7 @@ Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle
</div>
<div class="paragraph">
<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 &lt;shortname&gt; befindet.</p>
<code>template/qtgui</code> und nur <code>/qtgui</code>, relativ zum Stammverzeichnis, wo sich die ausführbare Datei fluajho befindet.</p>
</div>
<div class="paragraph">
<p>Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.</p>
@ -854,12 +854,12 @@ Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle
</ul>
</div>
<div class="paragraph">
<p>Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte &lt;shortname&gt; mit diesem Befehl vom Terminal aus:</p>
<p>Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte fluajho mit diesem Befehl vom Terminal aus:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>LANGUAGE=de_DE.UTF-8 ./&lt;shortname&gt; -V --save /dev/null</code></p>
<p><code>LANGUAGE=de_DE.UTF-8 ./fluajho -V --save /dev/null</code></p>
</li>
</ul>
</div>
@ -869,7 +869,7 @@ Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-26 18:51:45 +0100
Last updated 2019-01-26 18:52:51 +0100
</div>
</div>
</body>

Loading…
Cancel
Save