From 12db0fc8f015f416095bed86e3e937a236bb3314 Mon Sep 17 00:00:00 2001
From: Martin Brodbeck <martin@brodbeck-online.de>
Date: Thu, 12 Aug 2021 14:28:14 +0200
Subject: [PATCH] README added

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f8d5169
--- /dev/null
+++ b/README.md
@@ -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
+  ```