diff --git a/README.md b/README.md index 405ebfa..ef8abfe 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ -[//]: # (Generated 2021-02-13T20:17:14.249024. Changes belong into template/documentation/readme.template) +[//]: # (Generated 2021-09-03T19:11:13.613874. Changes belong into template/documentation/readme.template) -#Patroneo -Program version 2.1.0 +#Tembro +Program version 0.0.1 -![Screenshot](https://git.laborejo.org/lss/Patroneo/raw/branch/master/documentation/screenshot.png "Screenshot") +![Screenshot](https://git.laborejo.org/lss/Tembro/raw/branch/master/documentation/screenshot.png "Screenshot") -Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a -program that sends digital "notes" to software instruments such as synthesizers and samplers. +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. -Patroneo is primarily designed for educational purposes, where the main goal is to teach the -importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer -you can use to create real music. The constraints it presents will more likely boost your -creativity than suppressing it. +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. -You have tracks with one pattern each. Turn on steps in the pattern to play -musical notes. Switch the patterns on and off in a sequence to create a song structure. -Connect external synthesizers and samplers to create sounds. +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/ This README is just a short introduction. Consult the manual (see below) for more information. @@ -29,7 +30,7 @@ This README is just a short introduction. Consult the manual (see below) for mor * Website https://www.laborejo.org * Bugs and Issues: https://www.laborejo.org/bugs * Git Repositories for all programs: https://git.laborejo.org -* Documentation and Manual https://www.laborejo.org/documentation/patroneo +* Documentation and Manual https://www.laborejo.org/documentation/tembro # Installation and Starting @@ -42,7 +43,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 https://git.laborejo.org/lss/patroneo.git` +`git clone https://git.laborejo.org/lss/tembro.git` ## Dependencies * Glibc @@ -67,25 +68,25 @@ It is possible to clone a git repository. ## Starting -There are multiple ways to run Patroneo which should give you the flexibility to configure your +There are multiple ways to run Tembro which should give you the flexibility to configure your system as you want. -We make no distinction if you installed Patroneo yourself or through the distributions package-manager. +We make no distinction if you installed Tembro yourself or through the distributions package-manager. The differences are: With or without Agordejo, with or without sound, installed or from the source dir. ### Installed , running through Agordejo (New Session Manager) (recommended) -Starting Patroneo through Agordejo after you installed patroneo system-wide +Starting Tembro through Agordejo after you installed tembro system-wide is the recommended and only supported way. Start agordejo and load or create a new -session. Then use the program launcher to add `patroneo`. +session. Then use the program launcher to add `tembro`. It should appear with an icon in the list and open its GUI. ### Installed without Agordejo -If you start patroneo directly it will present you with a dialog to choose your session directory. +If you start tembro directly it will present you with a dialog to choose your session directory. -You can also start patroneo from a terminal (or create a starter script). +You can also start tembro from a terminal (or create a starter script). -`patroneo --save DIRECTORY` +`tembro --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). @@ -100,35 +101,35 @@ Closing through your window manager in this mode will actually quit the applicat prompt to save changes. ## From source directory -You can run Patroneo after extracting the release archive or cloning from git, without installation. +You can run Tembro after extracting the release archive or cloning from git, without installation. ### Calfbox "Calfbox" is the name of our internal realtime midi/audio python module. * It is bundled with the application for a normal install. -* Or you could run `./configure` and `make calfbox` without subsequent install, which creates a `sitepackages` directory in the source dir. You can then run `./patroneo` directly from the source. -* A third option is `./patroneo --mute` which runs without sound at all and does not need calfbox. +* Or you could run `./configure` and `make calfbox` without subsequent install, which creates a `sitepackages` directory in the source dir. You can then run `./tembro` directly from the source. +* A third option is `./tembro --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 `patroneo` into your PATH. e.g. /usr/bin +After extracting the release archive create a symlink from `tembro` 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 `./patroneo.bin` +If you compiled without installing you can also symlink to `./tembro.bin` ### From source dir without NSM -Use `./patroneo --save` (see above). If you compiled without installing you can also run `./patroneo.bin` +Use `./tembro --save` (see above). If you compiled without installing you can also run `./tembro.bin` ### No NSM, no Make, No Sound Combining the above options you can start the program directly after unpacking or cloning from git: -`./patroneo --save /tmp --mute` +`./tembro --save /tmp --mute` Or even shorter: -`./patroneo -s /tmp -m` +`./tembro -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/configure b/configure index 4040c37..7ff83a5 100755 --- a/configure +++ b/configure @@ -1,6 +1,6 @@ #!/bin/bash program=tembro cboxconfigure="--without-fluidsynth --without-libsmf" -version=0.1.0 +version=0.0.1 . template/configure.template #. is the posix compatible version of source diff --git a/desktop/desktop.desktop b/desktop/desktop.desktop index 3cba960..ac6c633 100644 --- a/desktop/desktop.desktop +++ b/desktop/desktop.desktop @@ -1,9 +1,9 @@ [Desktop Entry] Type=Application -Name=QtCboxNsm Exämple ツ -Comment=Just an example -Exec=exampleClientCboxQtNsm -Icon=exampleClientCboxQtNsm +Name=Tembro +Comment=Sampled Software Instruments +Exec=tembro +Icon=tembro Terminal=false StartupNotify=false Version=1.0 diff --git a/documentation/english.adoc b/documentation/english.adoc new file mode 100644 index 0000000..9bfe309 --- /dev/null +++ b/documentation/english.adoc @@ -0,0 +1,134 @@ +:Author: Laborejo Software Suite +:Version: 0.0.1 +: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 + += Tembro + +// Don't write in the empty line above line. It will be interpreted as author html tag +For program version 0.0.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/ + + +== Usage +* Nothing +* To +* See +* Here + + +== 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 + ** Download the latest version from https://www.laborejo.org/downloads and extract it. + ** git clone https://git.laborejo.org/lss/tembro.git +* 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. + +== Help and Development +You can help Tembro 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 +* Report bugs and issues: https://www.laborejo.org/bugs +* Website: https://www.laborejo.org +* E-Mail: info@laborejo.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 +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 `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 tembro via the terminal: + +* `LANGUAGE=de_DE.UTF-8 ./tembro -V --save /dev/null` diff --git a/documentation/german.adoc b/documentation/german.adoc new file mode 100644 index 0000000..b27c3c6 --- /dev/null +++ b/documentation/german.adoc @@ -0,0 +1,126 @@ +:Author: Laborejo Software Suite +:Version: 0.0.1 +: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 + += Tembro + +// Don't write in the empty line above line. It will be interpreted as author html tag +Für Programmversion 0.0.1 + +== Bedienung +Hier gibt es nichts zu sehen. + +* Weiter +* Gehen + + + +== 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 +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* +* 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. + ** `git clone https://git.laborejo.org/lss/tembro.git` +* Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle: +*`./configure --prefix=/usr` + ** Das Standardprefix is /usr/local +* `make` +* `sudo make install` + +.tembro im Agordejo (New Session Manager, NSM) starten +* Starten Sie `agordejo` +* Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein. +* Benutzen Sie den Launcher um `tembro` hinzuzufügen. +* Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer. + +In der Datei README.md befinden sich weitere Möglichkeiten tembro zu starten. Diese sind zum +Musikmachen nicht praktikabel, aber nützlich für Tests und Entwicklung. + +== Helfen und Entwicklung +Sie können Tembro auf viele Arten und Weisen helfen: Testen und Fehler melden, übersetzen, marketing, +anderen Nutzern helfen und schließlich programmieren. + +=== Testen und Programmfehler +Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden Sie diese bitte auf +eine Art und Weise, die ihnen am besten passt. + +.Kontaktmöglichkeiten +* Bugs und Probleme melden: https://www.laborejo.org/bugs +* Webseite: https://www.laborejo.org +* E-Mail: info@laborejo.org +* Wenn Sie die Gelegenheiten sehen und wissen, dass ein Entwickler es lesen wird sind auch Foren, Socialmedia etc. möglich. + +== Entwicklung +Falls Sie an der Entwicklung interessiert sind, melden Sie sich am besten direkt bei uns (s.o.) +Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns eine git URL zukommen lassen. + +=== Übersetzungen +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" +(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 +tembro 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: + +* Öffnen Sie ein Terminal und navigieren zu template/qtgui/resources/translations +* Bearbeiten Sie die Datei `config.pro` in einem Texteditor. + ** Hängem Sie in der letzten Zeile den Namen der neuen Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist. + ** Achten Sie bitte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen +* Führen Sie `sh update.sh` im selben Verzeichnis aus. + ** Das Programm hat nun eine neue `.ts`-Datei im Verzeichnis erstellt. +* Starten Sie Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffnen von dort die neu generierte Datei. +* Wählen Sie die "Target Language", also Zielsprache, aus und benutzen das Programm um eine Übersetzung anzufertigen. +* Senden Sie uns bitte 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 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. +* 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"}` + ** 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())` + + +Um die neue Übersetzung zu testen starten Sie das Programm, falls ihr System bereits auf diese +Sprache eingstellt ist. +Ansonsten starten Sie tembro mit diesem Befehl, Sprachcode ändern, vom Terminal aus: + +* `LANGUAGE=de_DE.UTF-8 ./tembro -V` diff --git a/documentation/index.adoc b/documentation/index.adoc index de08f69..7211069 100644 --- a/documentation/index.adoc +++ b/documentation/index.adoc @@ -1,5 +1,5 @@ :Author: Laborejo Software Suite -:Version: 2.1.0 +:Version: 0.0.1 :iconfont-remote!: :!webfonts: @@ -18,10 +18,10 @@ https://asciidoctor.org/docs/user-manual/ :nofooter: -== Patroneo Multi-Language Documentation +== Tembro Multi-Language Documentation image::logo.png["logo", 320, 180] -For program version 2.1.0 +For program version 0.0.1 This site is part of the https://www.laborejo.org[Laborejo Software Suite] @@ -33,5 +33,6 @@ Please choose a language Further Links + * https://laborejo.org/bugs/[Bug and Issues, and other Feedback] * Write to info@laborejo.org for any comment or question. diff --git a/documentation/manpageinclude.h2m b/documentation/manpageinclude.h2m index 210cb2b..5f0dd52 100644 --- a/documentation/manpageinclude.h2m +++ b/documentation/manpageinclude.h2m @@ -1,45 +1,46 @@ [name] -Patroneo - Easy to use pattern based midi sequencer. +Tembro - Sampled Software Instruments [usage] -Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a -program that sends digital "notes" to software instruments such as synthesizers and samplers. +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. -Patroneo is primarily designed for educational purposes, where the main goal is to teach the -importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer -you can use to create real music. The constraints it presents will more likely boost your -creativity than suppressing it. +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. -You have tracks with one pattern each. Turn on steps in the pattern to play -musical notes. Switch the patterns on and off in a sequence to create a song structure. -Connect external synthesizers and samplers to create sounds. +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/ [Reporting bugs] https://www.laborejo.org/bugs [copyright] -Patroneo 2.1.0 - Copyright 2021 +Tembro 0.0.1 - Copyright 2021 Laborejo Software Suite https://www.laborejo.org/ [examples] -Start patroneo through NSM, e.g. through Agordejo. This will take care of all +Start tembro through NSM, e.g. through Agordejo. This will take care of all settings and save directories. Other modes of operations, mostly for testing, are: Run without session management and save in /tmp. - patroneo --save /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 - patroneo --mute + tembro --mute [see also] -The full documentation for Patroneo is maintained as a multi-lingual html site to your systems doc-dir. +The full documentation for Tembro is maintained as a multi-lingual html site to your systems doc-dir. For example: - xdg-open file:///usr/share/doc/patroneo/index.html + xdg-open file:///usr/share/doc/tembro/index.html -The documentation can also be found online https://www.laborejo.org/documentation/patroneo +The documentation can also be found online https://www.laborejo.org/documentation/tembro diff --git a/documentation/out/german.html b/documentation/out/german.html new file mode 100644 index 0000000..76f60bd --- /dev/null +++ b/documentation/out/german.html @@ -0,0 +1,714 @@ + + + + + + + + +Tembro + + + + +
+
+
+
+

Für Programmversion 0.0.1

+
+
+
+
+

1. Bedienung

+
+
+

Hier gibt es nichts zu sehen.

+
+
+
    +
  • +

    Weiter

    +
    • +
  • +

    Gehen

    +
    • +
+
+
+
+
+

2. 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 +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*
+
    +
  • +

    Eine Liste der Abhängigkeit befindet sich in der README.md

    +
    • +
  • +

    Kompilieren und Installieren geht entweder mit einem Releasedownload oder mit der Git-Version:

    +
    + +
    +
    • +
  • +

    Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle: +*./configure --prefix=/usr

    +
    +
      +
    • +

      Das Standardprefix is /usr/local

      +
      • +
    +
    +
    • +
  • +

    make

    +
    • +
  • +

    sudo make install

    +
    • +
+
+
+
tembro im Agordejo (New Session Manager, NSM) starten
+
    +
  • +

    Starten Sie agordejo

    +
    • +
  • +

    Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein.

    +
    • +
  • +

    Benutzen Sie den Launcher um tembro hinzuzufügen.

    +
    • +
  • +

    Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer.

    +
    • +
+
+
+

In der Datei README.md befinden sich weitere Möglichkeiten tembro zu starten. Diese sind zum +Musikmachen nicht praktikabel, aber nützlich für Tests und Entwicklung.

+
+
+
+
+

3. Helfen und Entwicklung

+
+
+

Sie können Tembro auf viele Arten und Weisen helfen: Testen und Fehler melden, übersetzen, marketing, +anderen Nutzern helfen und schließlich programmieren.

+
+
+

3.1. Testen und Programmfehler

+
+

Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden Sie diese bitte auf +eine Art und Weise, die ihnen am besten passt.

+
+
+
Kontaktmöglichkeiten
+ +
+
+
+
+
+

4. Entwicklung

+
+
+

Falls Sie an der Entwicklung interessiert sind, melden Sie sich am besten direkt bei uns (s.o.) +Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns eine git URL zukommen lassen.

+
+
+

4.1. Übersetzungen

+
+

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" +(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 +tembro 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:

+
+
+
    +
  • +

    Öffnen Sie ein Terminal und navigieren zu template/qtgui/resources/translations

    +
    • +
  • +

    Bearbeiten Sie die Datei config.pro in einem Texteditor.

    +
    +
      +
    • +

      Hängem Sie in der letzten Zeile den Namen der neuen Sprache an, in der Form XY.ts, wobei XY der Sprachcode ist.

      +
      • +
    • +

      Achten Sie bitte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen

      +
      • +
    +
    +
    • +
  • +

    Führen Sie sh update.sh im selben Verzeichnis aus.

    +
    +
      +
    • +

      Das Programm hat nun eine neue .ts-Datei im Verzeichnis erstellt.

      +
      • +
    +
    +
    • +
  • +

    Starten Sie Qt Linguist mit linguist-qt5 (kann evtl. anders heißen) und öffnen von dort die neu generierte Datei.

    +
    • +
  • +

    Wählen Sie die "Target Language", also Zielsprache, aus und benutzen das Programm um eine Übersetzung anzufertigen.

    +
    • +
  • +

    Senden Sie uns bitte 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 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 <file>translations/de.qm</file> . 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"}

    +
    +
      +
    • +

      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())

      +
      • +
    +
    +
    • +
+
+
+

Um die neue Übersetzung zu testen starten Sie das Programm, falls ihr System bereits auf diese +Sprache eingstellt ist. +Ansonsten starten Sie tembro mit diesem Befehl, Sprachcode ändern, vom Terminal aus:

+
+
+
    +
  • +

    LANGUAGE=de_DE.UTF-8 ./tembro -V

    +
    • +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/documentation/out/index.html b/documentation/out/index.html new file mode 100644 index 0000000..f9d1058 --- /dev/null +++ b/documentation/out/index.html @@ -0,0 +1,487 @@ + + + + + + + +Tembro Multi-Language Documentation + + + + +
+
+

Tembro Multi-Language Documentation

+
+
+
+logo +
+
+
+

For program version 0.0.1

+
+
+

This site is part of the Laborejo Software Suite

+
+
+

Please choose a language

+
+
+ +
+
+

Further Links

+
+
+ +
+
+
+
+ + \ No newline at end of file diff --git a/documentation/tembro.1 b/documentation/tembro.1 new file mode 100644 index 0000000..c83b48d --- /dev/null +++ b/documentation/tembro.1 @@ -0,0 +1,71 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5. +.TH TEMBRO "1" "September 2021" "Tembro 0.0.1" "User Commands" +.SH NAME +Tembro - Sampled Software Instruments +.SH DESCRIPTION +usage: tembro [\-h] [\-v] [\-s DIRECTORY] [\-p] [\-m] [\-V] +.PP +Tembro \- Version 0.0.1 \- Copyright 2021 by Laborejo Software Suite \- +https://www.laborejo.org/tembro +.SS "optional arguments:" +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-v\fR, \fB\-\-version\fR +show program's version number and exit +.TP +\fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY +Use this directory to save. Will be created or loaded +from if already present. Deactivates Agordejo/NewSession\-Manager support. +.TP +\fB\-p\fR, \fB\-\-profiler\fR +(Development) Run the python profiler and produce a +\&.cprof file at quit. The name will appear in your +STDOUT. +.TP +\fB\-m\fR, \fB\-\-mute\fR +(Development) Use a fake cbox module, effectively +deactivating midi and audio. +.TP +\fB\-V\fR, \fB\-\-verbose\fR +(Development) Switch the logger to INFO and print out +all kinds of information to get a high\-level idea of +what the program is doing. +.SH USAGE + +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/ +.SH EXAMPLES +Start tembro through NSM, e.g. through Agordejo. This will take care of all +settings and save directories. + +Other modes of operations, mostly for testing, are: + +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 +.SH "REPORTING BUGS" +https://www.laborejo.org/bugs +.SH COPYRIGHT +Tembro 0.0.1 - Copyright 2021 +Laborejo Software Suite +https://www.laborejo.org/ +.SH "SEE ALSO" +The full documentation for Tembro is maintained as a multi-lingual html site to your systems doc-dir. +For example: + xdg-open file:///usr/share/doc/tembro/index.html + +The documentation can also be found online https://www.laborejo.org/documentation/tembro diff --git a/engine/config.py b/engine/config.py index 68d88c8..2c1126d 100644 --- a/engine/config.py +++ b/engine/config.py @@ -21,7 +21,7 @@ METADATA={ #release announcements, entries in software directories etc. "tagline" : 'Sampled Software Instruments ', - "version" : "0.1.0", + "version" : "0.0.1", "year" : "2021", "author" : "Laborejo Software Suite", "url" : "https://www.laborejo.org/tembro", @@ -57,6 +57,9 @@ All projects and all users have the same "instrument" with the same instrument s 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/ """, "dependencies" : "\n".join("* "+dep for dep in ()), diff --git a/engine/main.py b/engine/main.py index 6c5758d..8e93f5c 100644 --- a/engine/main.py +++ b/engine/main.py @@ -241,7 +241,7 @@ class Library(object): logger.info(f"Parsing {tarFilePath}") - needTarData = False #TODO: If we have images etc. in the future. + needTarData = True #TODO: If we have images etc. in the future. if needTarData: with tarfile.open(name=tarFilePath, mode='r:') as opentarfile: iniFileObject = TextIOWrapper(opentarfile.extractfile("library.ini"))