From 9e14d0c05745351ae0b30aabae812738c1fa85a1 Mon Sep 17 00:00:00 2001 From: Nils <> Date: Mon, 3 Jan 2022 01:10:44 +0100 Subject: [PATCH] Update documentation and info files --- README.md | 3 +- documentation/build-documentation.sh | 6 +- documentation/english.adoc | 3 +- documentation/german.adoc | 19 +- documentation/index.adoc | 2 +- documentation/manpageinclude.h2m | 9 +- documentation/out/english.html | 734 +++++++++++++++++++++++++++ documentation/out/favicon.ico | Bin 0 -> 4286 bytes documentation/out/favicon.png | Bin 0 -> 546 bytes documentation/out/german.html | 19 +- documentation/out/logo.png | Bin 0 -> 37984 bytes documentation/tembro.1 | 16 +- 12 files changed, 773 insertions(+), 38 deletions(-) create mode 100644 documentation/out/english.html create mode 100644 documentation/out/favicon.ico create mode 100644 documentation/out/favicon.png create mode 100644 documentation/out/logo.png diff --git a/README.md b/README.md index b4844fa..a8766c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[//]: # (Generated 2021-09-03T19:21:10.440305. Changes belong into template/documentation/readme.template) +[//]: # (Generated 2022-01-03T01:10:44.123191. Changes belong into template/documentation/readme.template) #Tembro Program version 0.0.1 @@ -25,7 +25,6 @@ Download them to a location of your choice set the sample file location from wit menu. Then restart the program. - This README is just a short introduction. Consult the manual (see below) for more information. # Contact and Information diff --git a/documentation/build-documentation.sh b/documentation/build-documentation.sh index bb271f4..5d0cbc6 100755 --- a/documentation/build-documentation.sh +++ b/documentation/build-documentation.sh @@ -8,11 +8,9 @@ set -e asciidoctor index.adoc -o out/index.html asciidoctor german.adoc -o out/german.html -cp overview-german.png out/overview-german.png asciidoctor english.adoc -o out/english.html -cp overview-english.png out/overview-english.png -#cp *-quickstart*.mp4 out/ +cp ../desktop/images/favicon.* out/ +cp ../desktop/images/1248-transparent.png out/logo.png -cp favicon.* out/ diff --git a/documentation/english.adoc b/documentation/english.adoc index cc2d785..992744a 100644 --- a/documentation/english.adoc +++ b/documentation/english.adoc @@ -1,4 +1,4 @@ -:Author: Laborejo Software Suite +:Author: Laborejo Software Suite and Krzysztof Foltman :Version: 0.0.1 :iconfont-remote!: :!webfonts: @@ -46,7 +46,6 @@ Download them to a location of your choice set the sample file location from wit menu. Then restart the program. - == Usage * Nothing * To diff --git a/documentation/german.adoc b/documentation/german.adoc index b27c3c6..a813906 100644 --- a/documentation/german.adoc +++ b/documentation/german.adoc @@ -1,4 +1,4 @@ -:Author: Laborejo Software Suite +:Author: Laborejo Software Suite and Krzysztof Foltman :Version: 0.0.1 :iconfont-remote!: :!webfonts: @@ -38,19 +38,19 @@ Hier gibt es nichts zu sehen. == Installation und Start Tembro ist exklusiv für Linux. Am besten installieren Sie Tembro über deinen Paketmanager. -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 Tembro bereitzustellen. Falls in den Paketquellen vorhanden bitte direkt bei "tembro in Agordejo (New Session Manager)" weiterlesen. Falls nicht kann man Tembro auch selbst "bauen". -.Abhängigkeiten* +.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: - ** Laden Sie von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacken Sie sie. + ** Laden Sie von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacken Sie sie. ** `git clone https://git.laborejo.org/lss/tembro.git` * Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle: -*`./configure --prefix=/usr` + ** `./configure --prefix=/usr` ** Das Standardprefix is /usr/local * `make` * `sudo make install` @@ -86,8 +86,8 @@ Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns eine g Tembro 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. Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" +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 @@ -112,9 +112,10 @@ So fügt man eine neue Sprache hinzu: Die Übersetzung können Sie auch selbst, zum Testen, 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 die `.ts` Datei.* Bearbeiten Sie `template/qtgui/resources/resources.qrc` und kopieren die Zeile `translations/de.qm` . 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 `translations/de.qm` . Dabei das Länderkürzel zum Neuen ändern. * Führen Sie `sh buildresources.sh` aus -* Bearbeiten Sie `engine/config.py`: Die neue Sprache hinzufügen. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}` +* Bearbeiten Sie `engine/config.py`: Die neue Sprache hinzufügen. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}` ** Um den Sprachstring herauszufinden öffnen Sie den `python3`-Interpreter im Terminal und führen aus: ** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())` diff --git a/documentation/index.adoc b/documentation/index.adoc index 7211069..4e1ea20 100644 --- a/documentation/index.adoc +++ b/documentation/index.adoc @@ -1,4 +1,4 @@ -:Author: Laborejo Software Suite +:Author: Laborejo Software Suite and Krzysztof Foltman :Version: 0.0.1 :iconfont-remote!: :!webfonts: diff --git a/documentation/manpageinclude.h2m b/documentation/manpageinclude.h2m index e5be6bc..2967d57 100644 --- a/documentation/manpageinclude.h2m +++ b/documentation/manpageinclude.h2m @@ -20,13 +20,12 @@ Download them to a location of your choice set the sample file location from wit menu. Then restart the program. - [Reporting bugs] https://www.laborejo.org/bugs [copyright] -Tembro 0.0.1 - Copyright 2021 -Laborejo Software Suite +Tembro 0.0.1 - Copyright 2022 +Laborejo Software Suite and Krzysztof Foltman https://www.laborejo.org/ [examples] @@ -35,11 +34,11 @@ settings and save directories. Other modes of operations, mostly for testing, are: -Run without session management and save in /tmp. +Run without session management and save in /tmp. tembro --save /tmp Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots - tembro --mute + tembro --mute [see also] The full documentation for Tembro is maintained as a multi-lingual html site to your systems doc-dir. diff --git a/documentation/out/english.html b/documentation/out/english.html new file mode 100644 index 0000000..1c55c29 --- /dev/null +++ b/documentation/out/english.html @@ -0,0 +1,734 @@ + + + + + + + + +Tembro + + + + +
+
+
+
+

For program version 0.0.1

+
+
+
+
+

1. Introduction

+
+
+

Tembro (which is Esperanto for musical "Timbre") is a virtual software instrument based on +samples. All instruments are permanently built-in, there is no option to load your own files. +New instruments are only added with new releases, old ones are never removed.

+
+
+

That makes Tembro reliable, predictable, portable and compatible. +All projects and all users have the same "instrument" with the same instrument sounds, +numbering system, midi controls etc.

+
+
+

Only "soft" settings, such as filters, can be changed dynamically and will be saved in your project.

+
+
+

At the moment this software is in its ALPHA phase. You need to manually download instrument +files from https://laborejo.org/downloads/tembro-instruments/ . Do not unpack the .tar files! +Download them to a location of your choice set the sample file location from within Tembros Edit +menu. Then restart the program.

+
+
+
+
+

2. Usage

+
+
+
    +
  • +

    Nothing

    +
    • +
  • +

    To

    +
    • +
  • +

    See

    +
    • +
  • +

    Here

    +
    • +
+
+
+
+
+

3. Installation and Start

+
+
+

Tembro 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 tembro from Agordejo / New Session Manager". +If not, you can build Tembro yourself.

+
+
+
Build and Install
+
    +
  • +

    Please check the supplied README.md for dependencies.

    +
    • +
  • +

    You can download a release or clone the git version

    +
    + +
    +
    • +
  • +

    Change into the new directory and use these commands:

    +
    • +
  • +

    ./configure --prefix=/usr

    +
    +
      +
    • +

      The default prefix is /usr/local

      +
      • +
    +
    +
    • +
  • +

    make

    +
    • +
  • +

    sudo make install

    +
    • +
+
+
+
Start tembro from Agordejo (New Session Manager, NSM)
+
    +
  • +

    Run agordejo

    +
    • +
  • +

    Press the New button, and enter a name for your piece of music.

    +
    • +
  • +

    Use the launcher to add tembro to the session.

    +
    • +
  • +

    Add any compatible programs, e.g. synthesizers.

    +
    • +
+
+
+

Please read README.md for other ways of starting tembro, which are impractical for actual use but can +be helpful for testing and development.

+
+
+
+
+

4. Help and Development

+
+
+

You can help Tembro in several ways: Testing and reporting errors, translating, marketing, support, programming and more.

+
+
+

4.1. 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
+ +
+
+
+

4.2. 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.

+
+
+
+

4.3. Translations

+
+

Tembro 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 tembro executable is.

+
+
+

Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Tembro.

+
+
+

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

    +
    • +
+
+
+

You can also incorporate the translation into Tembro 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 <file>translations/de.qm</file> 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 tembro via the terminal:

+
+
+
    +
  • +

    LANGUAGE=de_DE.UTF-8 ./tembro -V --save /dev/null

    +
    • +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/documentation/out/favicon.ico b/documentation/out/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..fd9c808030b284d7ad31b6875eed955e3c62ab40 GIT binary patch literal 4286 zcmeHKv2KGf5WRL|>r{ydq)04fLSkmfz)!I91rbZ;d_u>BALtsvf*2#gXI=e>E^0|D z8Otqc#i7R;8}qpH`QV5i)UjR@&h+*~^h`uA3aX1X3g{n1jlDizaOoggtyY|->0|^! zz~}RM0NN(ca9x*^Bw-WT@Aup^%>cAb1l;$;UsV<7d9H;xj=3yLJ|2&Zw(h*TuCJ~d z+n;3_tGM`4fJ0>A{~Uk!=zqs?IEo@8VD31crmjC?+f*>u7XRsV;-V%yf2{q-@Bdf%*S7tp`OjAT{Z;HvX4Yh z_5a-8UwLm^daC`lc;z_@|M&mjs10=M2*fsWIcgBJb?2eR5gGsgOTUi(FZCa4V3XR} NM*WT2U+s%otaV-hC4QqZKS}>*0*>Ry#v;F0IHa52ywLj?z2`QZ2X*XKD53<;|rRs3W^7OBJ z9FTC~V8N8GiAN7S=m^N^4{e+;A1Ay{dO^qiLjfQDD$VR$(r3Qd;^7_cng7!jVx(C@ zA3SCj&zh9{!TsdymbD2}E;&6*O8LKErERK(!v>gTe~DWM4fe-gV7 literal 0 HcmV?d00001 diff --git a/documentation/out/german.html b/documentation/out/german.html index d0aa0c7..27f704e 100644 --- a/documentation/out/german.html +++ b/documentation/out/german.html @@ -5,7 +5,7 @@ - + Tembro