summaryrefslogtreecommitdiffhomepage
path: root/gui/scripts/README.md
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2023-01-27 13:09:22 +0100
committerLinus Färnstrand <linus@mullvad.net>2023-01-27 13:09:22 +0100
commitab24340de89deaf49a0664f905e8ce056d7c2d69 (patch)
treeea5a01277261eef8ae758f84da8b13f2d0877d6a /gui/scripts/README.md
parent1824ee6b2aabbc497e01431c1af180e0cb2b2121 (diff)
parentfec0050c7f61dd11eff4c56f2728bb5cc1a20d1e (diff)
downloadmullvadvpn-ab24340de89deaf49a0664f905e8ce056d7c2d69.tar.xz
mullvadvpn-ab24340de89deaf49a0664f905e8ce056d7c2d69.zip
Merge branch 'update-icons-and-logos'
Diffstat (limited to 'gui/scripts/README.md')
-rw-r--r--gui/scripts/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/gui/scripts/README.md b/gui/scripts/README.md
index cd9b723045..7fd98fb217 100644
--- a/gui/scripts/README.md
+++ b/gui/scripts/README.md
@@ -1,7 +1,9 @@
This is a folder with the supporting scripts written in Python 3, node, bash.
-## Dependency installation notes
+## Maps and location translations
+
+### Dependency installation notes
1. Install GDAL/OGR dependencies, which are required by Fiona python package.
@@ -20,7 +22,7 @@ This is a folder with the supporting scripts written in Python 3, node, bash.
https://www.gnu.org/software/gettext/
-## Geo data installation notes
+### Geo data installation notes
Go to http://www.naturalearthdata.com/downloads/50m-cultural-vectors/ and
download ZIP files with the following shapes:
@@ -52,7 +54,7 @@ unzip ne_50m_admin_1_states_provinces_lines.zip -d ne_50m_admin_1_states_provinc
unzip ne_10m_populated_places.zip -d ne_10m_populated_places/
```
-## Geo data extraction notes
+### Geo data extraction notes
Run the following script to produce a TopoJSON data used by the app:
@@ -68,7 +70,7 @@ 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
+### 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:
@@ -77,7 +79,7 @@ copy all files ignoring intermediate ones into the `gui/assets/geo` folder:
python3 integrate-into-app.py
```
-## Locking Python dependencies
+### Locking Python dependencies
1. Freeze dependencies: