Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.85 KB

README.md

File metadata and controls

84 lines (52 loc) · 2.85 KB
Raw

This is a folder with gettext translations for Mullvad VPN app.

Adding new translations

  1. Create a new sub-folder under gui/locales, use the locale identifier for the folder name.

    The complete list of supported locale identifiers can be found at:

    https://electronjs.org/docs/api/locales

  2. Add a new language on Crowdin under Settings -> Translations -> Target languages menu.

    By default the file structure is configured to produce folders with translations using two-letter language code (defined under Settings -> Files -> -> ... [ellipsis] -> Settings).

    If you wish to add a dialect (i.e: pt-BR), you have to provide a custom mapping to tell Crowdin to output Portuguese (Brazil) as pt-BR instead of pt.

    In order to add a language mapping, go to Settings -> General Settings -> Language mapping (three faders icon on the left hand side of the "Translations" menu).

  3. Follow the procedure as described in gui/scripts/README.md.

  4. Optional: Upload the automatically translated <NEW_LOCALE>/relay-locations.po to Crowdin.

    Note: Replace <NEW_LOCALE> with the identifier of a newly added language.

    1. ZIP file with the following command:

      cd gui/locales
zip payload.zip <NEW_LOCALE>/relay-locations.po

    2. Upload payload.zip to Crowdin via web interface (Settings -> Translations -> Upload translations).

  5. Add the language to SUPPORTED_LOCALE_LIST in app.tsx.

Updating translations template

messages.pot

Run npm run update-translations to extract the new translations from the source code.

Android translations

The Android app uses translation strings stored in a different format, but which can be generated from the translations in this directory. For more information, see here.

relay-locations.pot

To update the countries and cities you have to run the geo data scripts. Follow the instructions in gui/scripts/README.md.

Uploading translations template to Crowdin

After updating the translations template (POT) locally, make sure to upload it to Crowdin:

CROWDIN_API_KEY=$YOUR_CROWDIN_KEY ./gui/scripts/crowdin.sh upload

Triggering Crowdin to start translating has to be done manually. Speak to the project owner

Downloading translations from Crowdin

Before downloading from Crowdin the project must be "built" first. When you later download you will receive the translations from the last point in time when it was built.

In order to make a fresh build with translations, use the following command:

CROWDIN_API_KEY=$YOUR_CROWDIN_KEY ./gui/scripts/crowdin.sh export

In order to download and integrate the new translations from Crowdin into the app, use the following command:

CROWDIN_API_KEY=$YOUR_CROWDIN_KEY ./gui/scripts/crowdin.sh download