diff --git a/documentation/build-documentation.sh b/documentation/build-documentation.sh index cee6dd0..e8a98e4 100755 --- a/documentation/build-documentation.sh +++ b/documentation/build-documentation.sh @@ -10,10 +10,10 @@ set -e asciidoctor index.adoc -o out/index.html asciidoctor german.adoc -o out/german.html -cp overview-german.png out/overview-german.png +#cp overview-german.png out/overview-german.png asciidoctor english.adoc -o out/english.html -cp overview-english.png out/overview-english.png +#cp overview-english.png out/overview-english.png cp ../desktop/images/favicon.* out/ cp ../desktop/images/1248-transparent.png out/logo.png diff --git a/documentation/out/english.html b/documentation/out/english.html new file mode 100644 index 0000000..7555e4e --- /dev/null +++ b/documentation/out/english.html @@ -0,0 +1,740 @@ + + + + + + + + +Laborejo + + + + +
+
+
+
+

For program version 2.0

+
+
+
+
+

1. Introduction

+
+
+

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

+
+
+
+
+

2. Usage

+
+
+
    +
  • +

    Nothing

    +
    • +
  • +

    To

    +
    • +
  • +

    See

    +
    • +
  • +

    Here

    +
    • +
+
+
+
+
+

3. 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 laborejo 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

    +
    + +
    +
    • +
  • +

    Change into the new directory and use these commands:

    +
    • +
  • +

    ./configure --prefix=/usr

    +
    +
      +
    • +

      The default prefix is /usr/local

      +
      • +
    +
    +
    • +
  • +

    make

    +
    • +
  • +

    sudo make install

    +
    • +
+
+
+
Start laborejo 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 laborejo here, in lower case.

    +
    • +
  • +

    Add Client again, this time jackpatch.

    +
    • +
  • +

    Add any compatible programs, e.g. synthesizers.

    +
    + +
    +
    • +
+
+
+

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

+
+
+
+
+

4. Help and Development

+
+
+

You can help Laborejo 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
+
    +
  • +

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

    +
    • +
+
+
+
+

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

+
+

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 laborejo 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

    +
    • +
+
+
+

You can also incorporate the translation into Laborejo 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 laborejo via the terminal:

+
+
+
    +
  • +

    LANGUAGE=de_DE.UTF-8 ./laborejo -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 0000000..e0d999b Binary files /dev/null and b/documentation/out/favicon.ico differ diff --git a/documentation/out/favicon.png b/documentation/out/favicon.png new file mode 100644 index 0000000..adc68e6 Binary files /dev/null and b/documentation/out/favicon.png differ diff --git a/documentation/out/german.html b/documentation/out/german.html index e8d44a6..1f51f42 100644 --- a/documentation/out/german.html +++ b/documentation/out/german.html @@ -719,7 +719,7 @@ Ansonsten starten Sie laborejo mit diesem Befehl, Sprachcode ändern, vom Termin diff --git a/documentation/out/logo.png b/documentation/out/logo.png new file mode 100644 index 0000000..47edc1a Binary files /dev/null and b/documentation/out/logo.png differ