Add readme

This commit is contained in:
Antonia 2024-08-24 21:30:37 +02:00
parent 78a31678d8
commit f4605b732c

32
README.md Normal file
View file

@ -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.