diff options
| author | Janito Vaqueiro Ferreira Filho <janito@mullvad.net> | 2020-08-11 14:34:05 +0000 |
|---|---|---|
| committer | Janito Vaqueiro Ferreira Filho <janito@mullvad.net> | 2020-08-12 11:11:55 +0000 |
| commit | bb15245c1e2e204631ad0590e73d26082032e9c2 (patch) | |
| tree | e6ac9534b3f6b204ea08e5f1b9f8f7c2b81d7b1f | |
| parent | 4d8c1bc9b5092c6261e53338c959ede101540869 (diff) | |
| download | mullvadvpn-bb15245c1e2e204631ad0590e73d26082032e9c2.tar.xz mullvadvpn-bb15245c1e2e204631ad0590e73d26082032e9c2.zip | |
Create a `README` file in the `android` directory
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | android/README.md | 29 | ||||
| -rw-r--r-- | gui/locales/README.md | 5 |
3 files changed, 36 insertions, 0 deletions
@@ -636,6 +636,8 @@ The menubar icons are described futher [here](./gui/assets/images/menubar%20icon Instructions for how to handle locales and translations are found [here](./gui/locales/README.md). +For instructions specific to the Android app, see [here](./android/README.md). + ## Audits, pentests and external security reviews Mullvad has used external pentesting companies to carry out security audits of this VPN app. Read diff --git a/android/README.md b/android/README.md new file mode 100644 index 0000000000..514ffd263c --- /dev/null +++ b/android/README.md @@ -0,0 +1,29 @@ +# Mullvad VPN Android app + +This directory contains the files specific to the Android app. + +## Translations / Localization + +The app has localized messages stored in `src/main/res/values-<locale>/` directories, where +`<locale>` is a two letter locale and can be followed by a two letter region code. For example: `en` +or `en-rGB`. + +The translated strings are based on the gettext translation files used for the desktop app. A helper +tool is available to create the translated string resource files based on the gettext translations, +in the `translations-converter` directory. The tool can be executed with the following commands +(assuming Rust and Cargo are installed, if not, follow the steps in the [root README][root-readme]): + +``` +cd translations-converter +cargo run +``` + +After the tool finishes executing, it creates the appropriate localized message files and +directories for each locale it can find in the [`gui/locales` directory][gui-locales]. It will also +update the [messages.pot] template file with the string messages from the Android app for which it +did not find any translation, making it simpler to use the template for obtaining those +translations. + +[root-readme]: ../README.md +[gui-locales]: ../gui/locales/ +[messages.pot]: ../gui/locales/messages.pot diff --git a/gui/locales/README.md b/gui/locales/README.md index 4f80bdecc6..c32f80f339 100644 --- a/gui/locales/README.md +++ b/gui/locales/README.md @@ -77,3 +77,8 @@ command: ``` CROWDIN_API_KEY=$YOUR_CROWDIN_KEY ./gui/scripts/crowdin.sh download ``` + +## 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](../../android/README.md). |