README added

This commit is contained in:
Martin Brodbeck 2021-08-12 14:28:14 +02:00
parent dcf844632e
commit 12db0fc8f0

33
README.md Normal file
View file

@ -0,0 +1,33 @@
# sp_replace_typ
Dieses Python-Skript passt mit Hilfe von TYP-Dateien und dem Tool
[GMT](https://www.gmaptool.eu) die Darstellung der Karte an.
Hierzu werden einige Parameter abgefragt, anhand derer die richtige
TYP-Datei ermittelt wird. Die eigentliche Arbeit verrichtet dann GMT.
## Systemvoraussetzungen
- Linux oder Windows
- Python >= 3.6
## Verwendung
Die Aufruf ist denkbar einfach. Zu beachten ist, dass es sich um ein
Kommandozeilentool handelt. Es gibt keine grafische Benutzeroberfläche.
Falls sich das Programm nicht im gleichen Verzeichnis wie die TYP-Dateien
befindet, kann das TYP-Verzeichnis angegeben werden.
Hier die Ausgabe von `sp_replace_typ.py --help`
```
usage: sp_replace_typ.py [-h] [-t TYPDIR] imgfile
Das Programm passt die Darstellung der Garmin-"Speichenkarte" an.
positional arguments:
imgfile Garmin gmapsupp-Datei
optional arguments:
-h, --help show this help message and exit
-t TYPDIR, --typdir TYPDIR
Verzeichnis mit den TYP-Dateien
```