From 179eee3febcf1af9ae181a32a18781411849d127 Mon Sep 17 00:00:00 2001 From: s3lph Date: Wed, 12 Oct 2022 02:48:14 +0200 Subject: [PATCH] Update README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b263d4..0d8622c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # erfamap -Generate a map similar to https://www.ccc.de/regional from Wikidata and the doku.ccc.de Semantic MediaWiki data. +Generate a map for https://www.ccc.de/regional from Wikidata, Nominatim and the doku.ccc.de Semantic MediaWiki data. ## TL;DR @@ -8,6 +8,7 @@ Generate a map similar to https://www.ccc.de/regional from Wikidata and the doku pip3 install -r requirements.txt export DOKU_CCC_DE_BASICAUTH=username:password ./generate_map.py --update-erfalist +ls -al out/ ``` ![Map as generated by this tool](map.readme.png) @@ -28,7 +29,13 @@ For a quick test run, point the script at the cache.example directory: ./generate_map.py --cache-directory cache.example ``` -Find the result in the files `map.svg` and `map.png`. +This creates the following files in `out/`: + +- `map.svg` is the map as a SVG image, with clickable links. +- `map.png` is the map as a PNG image. +- `imagemap.html` includes map.png, along with a HTML image map that makes the dots and labels clickable. +- `erfamap.html` includes map.svg, with map.png and an imagemap as fallback. +- `style/` contains the stylesheet and font. **If the wrong font is used in the PNG, make sure the chosen font is installed on your system.** ([CairoSVG](https://cairosvg.org/) does not support the use of `@font-face` in style sheets.)