Some more readme
This commit is contained in:
parent
cc40f4eb3a
commit
fe757fc2a1
1 changed files with 17 additions and 1 deletions
18
README.md
18
README.md
|
@ -12,7 +12,23 @@ 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`.
|
||||||
|
|
||||||
|
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.)
|
||||||
|
|
||||||
|
When not cache exists or forcing cache renewal, you need to provide the HTTP Basic Auth credentials to doku.ccc.de via an environment variable:
|
||||||
|
|
||||||
|
```
|
||||||
|
export DOKU_CCC_DE_BASICAUTH=username:password
|
||||||
|
```
|
||||||
|
|
||||||
|
A run without cache takes some time as it fetches all data from their sources:
|
||||||
|
|
||||||
|
1. Get a list of countries in Europe and federal states in Germany from [Wikidata](https://wikidata.org).
|
||||||
|
1. Download all these countries' and states' border shapes from Wikimedia Commons.
|
||||||
|
1. Get a list of Erfas & Chaostreffs from the doku.ccc.de Semantic Mediawiki API.
|
||||||
|
1. Resolve all POIs' (Erfas & Chaostreffs) street addresses' to geocoordinates using [Nominatim](https://nominatim.org/).
|
||||||
|
|
||||||
## Fonts
|
## Fonts
|
||||||
|
|
||||||
The font contained in `style/concertone-regular.ttf` was created by Johan Kallas (johankallas@gmail.com) and is licensed unter the terms of the SIL Open Font License v1.10.
|
The font contained in `style/concertone-regular.ttf` was created by Johan Kallas (johankallas@gmail.com) and is licensed unter the terms of the SIL Open Font License v1.10.
|
||||||
|
|
Loading…
Reference in a new issue