add README

1 files changed, 45 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0095c08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# gk2kml
+
+## Convert Gauss-Kru(e)ger Coordinates to WGS84
+
+Convert a GK Coordinate to WGS84 and (optionally) export
+output to a .kml file.
+
+Example usage:
+
+```
+./gk2kml.py -z 5 -w out 4973819 5403153
+48.544705978693315, 7.869524492879161
+Writing to kml file: out.kml
+```
+Easting and Northing value should be 7 chars, if 6, the programm will append a 0.
+
+$LON, $LAT and $NAME in template.kml will be replaced.
+
+### Usage
+
+```
+usage: gk2kml.py [-h] [-z [ZONE]] [-w [WRITE]] coord coord
+```
+
+### Help
+
+```
+Convert Gauss-Kru(e)ger Coordinates to WGS84
+
+positional arguments:
+  coord                 
+                        [easting northing] ([Rechtswert Hochwert])
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -z [ZONE], --zone [ZONE]
+                        
+                        Input Gauss-Kruger Zone (Default: 3)
+                        2 = 3deg Zone 2: Germany
+                        3 = 3deg Zone 3: Germany onshore between 7°30'E and 10°30'E
+                        4 = 3deg Zone 4: Germany onshore between 10°30'E and 13°30'E
+                        5 = 3deg Zone 5: Germany onshore east of 13°30'E
+  -w [WRITE], --write [WRITE]
+                        Write to file [filename] (.kml gets attached)
+```