summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAndrej Mihajlov <and@mullvad.net>2018-06-25 19:51:55 +0200
committerAndrej Mihajlov <and@mullvad.net>2018-06-25 19:51:55 +0200
commit4a5bb89558675c22c50df64f40efc26863645033 (patch)
tree68005a74785fbe5c0892f8672b398425794c6ac9
parent445b6012e30ef93a2696eff03a0c2bb3bc50942b (diff)
parent20bfda6927b7dc46cc83652778ad7f18c033d971 (diff)
downloadmullvadvpn-4a5bb89558675c22c50df64f40efc26863645033.tar.xz
mullvadvpn-4a5bb89558675c22c50df64f40efc26863645033.zip
Merge branch 'update-geodata-readme'
-rw-r--r--geo-data/README.md (renamed from geo-data/README)16
1 files changed, 8 insertions, 8 deletions
diff --git a/geo-data/README b/geo-data/README.md
index 71cb8a8b31..22cdc5ee52 100644
--- a/geo-data/README
+++ b/geo-data/README.md
@@ -2,16 +2,16 @@ This is a folder with python 2 and node scripts to produce geographical
data for the Mullvad VPN app.
-= Dependency installation notes =
+## Dependency installation notes
1. Run the following command in terminal to install python dependencies:
-pip install -r requirements.txt
+`pip install -r requirements.txt`
2. Run `npm install -g topojson-server` to install `geo2topo` tool which is
used by python scripts to convert GeoJSON to TopoJSON
-= 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:
@@ -47,7 +47,7 @@ unzip ne_50m_admin_1_states_provinces_lines.zip -d ne_50m_admin_1_states_provinc
unzip ne_50m_populated_places_simple.zip -d ne_50m_populated_places_simple
```
-= Geo data extraction notes =
+## Geo data extraction notes
Run the following script to produce a TopoJSON data used by the app:
@@ -61,13 +61,13 @@ and finally generate the R-Tree cache:
npx babel-node prepare-rtree.js
```
-At this point all of the data should be saved in geo-data/out folder.
+At this point all of the data should be saved in `geo-data/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 app/assets/geo folder:
+copy all files ignoring intermediate ones into the `app/assets/geo` folder:
```
python integrate-into-app.py
-``` \ No newline at end of file
+```