summaryrefslogtreecommitdiffhomepage
path: root/gui/scripts
diff options
context:
space:
mode:
authorOskar Nyberg <oskar@mullvad.net>2024-06-18 15:00:50 +0200
committerOskar Nyberg <oskar@mullvad.net>2024-06-25 15:24:49 +0200
commit0683ec1605ba50f2d557b8a8e3db54d2b7c5612b (patch)
tree3dab9a59d8d14721a75a4199fdb08209caae3670 /gui/scripts
parenta2150d26e21d20221232ed35709cc4427f7e14a9 (diff)
downloadmullvadvpn-0683ec1605ba50f2d557b8a8e3db54d2b7c5612b.tar.xz
mullvadvpn-0683ec1605ba50f2d557b8a8e3db54d2b7c5612b.zip
Update README in gui/scripts
Diffstat (limited to 'gui/scripts')
-rw-r--r--gui/scripts/README.md74
1 files changed, 9 insertions, 65 deletions
diff --git a/gui/scripts/README.md b/gui/scripts/README.md
index 7fd98fb217..8556bb85fb 100644
--- a/gui/scripts/README.md
+++ b/gui/scripts/README.md
@@ -5,79 +5,23 @@ This is a folder with the supporting scripts written in Python 3, node, bash.
### Dependency installation notes
-1. Install GDAL/OGR dependencies, which are required by Fiona python package.
-
- You can install GDAL via Homebrew on macOS:
- `brew install gdal`
-
- For other platforms, please follow the guide on https://gdal.org/download.html#binaries
-
-2. Run the following command in terminal to install python dependencies:
+1. Run the following command in terminal to install python dependencies:
`pip3 install -r requirements.txt`
-3. Run `npm install -g topojson-server` to install `geo2topo` tool which is
- used by python scripts to convert GeoJSON to TopoJSON
-
-4. Make sure you have gettext utilities installed.
+2. Make sure you have gettext utilities installed.
https://www.gnu.org/software/gettext/
-### Geo data installation notes
-
-Go to http://www.naturalearthdata.com/downloads/50m-cultural-vectors/ and
-download ZIP files with the following shapes:
-
-- Admin 0 – Countries
-- Admin 1 – States, provinces - boundary lines
-- Populated Places - simple dataset is enough
-
-or use cURL to download all ZIPs:
-
-```
-curl -L -O https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/50m/cultural/ne_50m_admin_0_countries.zip
-curl -L -O https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/50m/cultural/ne_50m_admin_1_states_provinces_lines.zip
-curl -L -O https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/10m/cultural/ne_10m_populated_places.zip
-```
-
-Extract the downloaded ZIP files into `scripts` folder.
-Make sure the following folders exist after extraction:
-
-- ne_50m_admin_0_countries
-- ne_50m_admin_1_states_provinces_lines
-- ne_10m_populated_places
-
-or use the following script:
-
-```
-unzip ne_50m_admin_0_countries.zip -d ne_50m_admin_0_countries/
-unzip ne_50m_admin_1_states_provinces_lines.zip -d ne_50m_admin_1_states_provinces_lines/
-unzip ne_10m_populated_places.zip -d ne_10m_populated_places/
-```
-
-### Geo data extraction notes
+### Update translations
-Run the following script to produce a TopoJSON data used by the app:
+See [locales/README.md](../locales/README.md) for information about how to handle translations.
-```
-python3 extract-geo-data.py
-```
+The `<repo>/scripts/localization` script is, among other things, calling into `fetch-relay-locations.py`
+and `integrate-relay-locations.py` in this directory.
-and finally generate the R-Tree cache:
-
-```
-npm exec ts-node prepare-rtree.ts
-```
-
-At this point all of the data should be saved in `gui/scripts/out` folder.
-
-### App integration notes
-
-Once you've extracted all the geo data, run the integration script that will
-copy all files ignoring intermediate ones into the `gui/assets/geo` folder:
-
-```
-python3 integrate-into-app.py
-```
+* `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`.
### Locking Python dependencies