From f4605b732ce26149bed68a5c757409b548163ac4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonia=20P=C3=A9rez-Cerezo?= Date: Sat, 24 Aug 2024 21:30:37 +0200 Subject: [PATCH] Add readme --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..63f036d --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Streckenkarte + +A tool to display maps of lines as vector tiles using leaflet. + + +## Dependencies + +* Tippecanoe +* ogrmerge (part of gdal-bin in Debian) + +## Usage + +This software is meant to be installed as a hosted installation for +several maps. This is done by putting the files in the `frontend` +directory on a web server so they appear as `/common/*`, and then +creating a directory for each map, with the maps appearing at +`/$mapname/`. This directory should contain a `strecken.pmtiles` +containing the vector tiles, as well as a `layers.json` containing +metadata, and the web server should be configured to display +`/common/index.html` when accessing `/$mapname/`. This can be achieved +on nginx with the following snippet: + +``` +location ~ /.+/$ { + rewrite ^/(.*)$ /common/index.html last; +} +``` + +The `strecken.pmtiles` file is best generated using the +`mapbuilder.sh` script. Furthermore, exporting maps from umap is +possible using the `umap-extractor.py` script, which takes care of +exporting the data as well as the graphical style for each layer.