summaryrefslogtreecommitdiffhomepage
path: root/desktop
diff options
context:
space:
mode:
authorOskar <oskar@mullvad.net>2024-11-05 09:07:39 +0100
committerOskar <oskar@mullvad.net>2024-11-14 16:43:38 +0100
commitcc831fd604a10a409480a33d526a2cb708de5584 (patch)
treeaf8912771fcba782fae340eab4054f33c240247c /desktop
parentd40ddb0ecc2a41b41d1b96af277e8f34994ccaa8 (diff)
downloadmullvadvpn-cc831fd604a10a409480a33d526a2cb708de5584.tar.xz
mullvadvpn-cc831fd604a10a409480a33d526a2cb708de5584.zip
Update documentation references to gui-directory
Diffstat (limited to 'desktop')
-rw-r--r--desktop/packages/mullvad-vpn/assets/images/menubar-icons/README.md4
-rw-r--r--desktop/packages/mullvad-vpn/locales/README.md38
-rw-r--r--desktop/packages/mullvad-vpn/scripts/README.md2
3 files changed, 22 insertions, 22 deletions
diff --git a/desktop/packages/mullvad-vpn/assets/images/menubar-icons/README.md b/desktop/packages/mullvad-vpn/assets/images/menubar-icons/README.md
index 818d0b6029..ca8b2eee48 100644
--- a/desktop/packages/mullvad-vpn/assets/images/menubar-icons/README.md
+++ b/desktop/packages/mullvad-vpn/assets/images/menubar-icons/README.md
@@ -4,8 +4,8 @@ This directory contains the images for the menubar/traybar. The content consists
manually.
## Build script
-The png/ico files are generated using the script `gui/scripts/build-menubar-icons.sh` which can be
-run from the `gui`-directory using
+The png/ico files are generated using the script `../../scripts/build-menubar-icons.sh` which can be
+run from the `desktop/packages/mullvad-vpn`-directory using
```sh
./scripts/build-menubar-icons.sh
```
diff --git a/desktop/packages/mullvad-vpn/locales/README.md b/desktop/packages/mullvad-vpn/locales/README.md
index a4713e3ac1..2b1a44cbc0 100644
--- a/desktop/packages/mullvad-vpn/locales/README.md
+++ b/desktop/packages/mullvad-vpn/locales/README.md
@@ -2,38 +2,38 @@ 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.
-
+1. Create a new sub-folder under `../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
-1. Add a new language on Crowdin under Settings -> Translations -> Target languages menu.
-
+1. 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 -> <FILE> -> ... [ellipsis] -> Settings).
-
- If you wish to add a dialect (i.e: `pt-BR`), you have to provide a custom mapping
+ language code (defined under Settings -> Files -> <FILE> -> ... [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
+
+ 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).
-1. Follow the procedure as described in `gui/scripts/README.md`.
+1. Follow the procedure as described in `../scripts/README.md`.
+
+1. Optional: Upload the automatically translated `<NEW_LOCALE>/relay-locations.po` to
+ Crowdin.
-1. 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
+ cd ../locales
zip payload.zip <NEW_LOCALE>/relay-locations.po
```
-
- 1. Upload `payload.zip` to Crowdin via web interface (Settings -> Translations -> Upload
+
+ 1. Upload `payload.zip` to Crowdin via web interface (Settings -> Translations -> Upload
translations).
1. Add the language to `SUPPORTED_LOCALE_LIST` in `app.tsx`.
diff --git a/desktop/packages/mullvad-vpn/scripts/README.md b/desktop/packages/mullvad-vpn/scripts/README.md
index 8556bb85fb..a4607c3227 100644
--- a/desktop/packages/mullvad-vpn/scripts/README.md
+++ b/desktop/packages/mullvad-vpn/scripts/README.md
@@ -21,7 +21,7 @@ and `integrate-relay-locations.py` in this directory.
* `fetch-relay-locations.py` fetches the relay list and extracts all country and city names.
* `intregrate-relay-locations.py` integrates the fetched relay locations into
-`<repo>/gui/locales/relay-locations.pot`.
+`../locales/relay-locations.pot`.
### Locking Python dependencies