s3lph/erfamap
s3lph/erfamap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
s3lph 2022-10-12 02:48:14 +02:00
parent a10e679a13
commit 179eee3feb
Signed by: s3lph
GPG key ID: 8AC98A811E5BEFF5
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,6 +1,6 @@
# erfamap # 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 ## 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 pip3 install -r requirements.txt
export DOKU_CCC_DE_BASICAUTH=username:password export DOKU_CCC_DE_BASICAUTH=username:password
./generate_map.py --update-erfalist ./generate_map.py --update-erfalist
ls -al out/
``` ```
![Map as generated by this tool](map.readme.png) ![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 ./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.) **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.)