From bff5ff79bd55b42ededaff6083f1550b87bfce8c Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 28 Mar 2021 16:30:08 +0200 Subject: [PATCH] Added i18n instructions to the docs --- docs/source/int_started.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst index 385f99fc..bcf6195d 100644 --- a/docs/source/int_started.rst +++ b/docs/source/int_started.rst @@ -99,6 +99,30 @@ Make sure the install location for pip is in your PATH variable. This is not alw default. +.. _a_started_i18n: + +Building the Translation Files +============================== + +If you installed novelWriter from a package, the translation files should be pre-built and +included. If you're running novelWriter from the source code, you will need to generate the files +yourself. The files you need will be written to the ``i18n`` folder, and will have the ``.qm`` file +extension. + +You can build the ``.qm`` files with: + +.. code-block:: console + + python3 setup.py qtlrelease + +This requires that the Python package ``pylupdate5`` to be installed. + +.. note:: + If you want to improve novelWriter with translation files for another language, or update an + existing translation, instructions for how to contribute can be found in the README file in the + ``i18n`` folder of the source code. + + .. _a_started_docs: Building the Documentation