Some more readme
This commit is contained in:
parent
fe757fc2a1
commit
20ddf86281
1 changed files with 11 additions and 1 deletions
12
README.md
12
README.md
|
@ -4,6 +4,14 @@ Generate a map similar to https://www.ccc.de/regional from Wikidata and the doku
|
|||
|
||||
![Map as generated by this tool](map.png)
|
||||
|
||||
## Installation
|
||||
|
||||
1. Create a Python virtualenv: `python3 -m virtualenv venv`
|
||||
1. Enable the virtualenv: `. venv/bin/activate`
|
||||
1. Install the dependencies: `pip install -r requirements.txt`
|
||||
|
||||
Instead of following these steps, you could also install the dependencies from your OS' package manager.
|
||||
|
||||
## Usage
|
||||
|
||||
For a quick test run, point the script at the cache.example directory:
|
||||
|
@ -14,7 +22,7 @@ For a quick test run, point the script at the cache.example directory:
|
|||
|
||||
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.)
|
||||
**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:
|
||||
|
||||
|
@ -29,6 +37,8 @@ A run without cache takes some time as it fetches all data from their sources:
|
|||
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/).
|
||||
|
||||
**Use the cache at least for the country and state borders. Otherwise, Wikidata will start rate limiting pretty quickly.**
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue