diff Readme.rst @ 10:1944acce0e6f

Add --output= option.
author David Barts <n5jrn@me.com>
date Thu, 26 Aug 2021 08:37:46 -0700
parents c20b5314774f
children
line wrap: on
line diff
--- a/Readme.rst	Wed Aug 25 08:45:36 2021 -0700
+++ b/Readme.rst	Thu Aug 26 08:37:46 2021 -0700
@@ -38,7 +38,7 @@
    on the need for TopoTiler in the first place. If this program proves useful
    to a lot of people, and the consensus among its user base is that a GUI
    would be beneficial, I will probably add one.
-   
+
 Prerequisites
 -------------
 
@@ -65,9 +65,12 @@
 
 -l/--layers
         Comma-separated list of layers to include. See below for default.
+-o/--output
+        Specify output file. Defaults to input file with extention changed
+        to .tiff.
 -r/--resolution
         Output resolution in DPI. Default is 300.
-        
+
 Environment
 ^^^^^^^^^^^
 
@@ -85,5 +88,30 @@
 By default, all ``Map_Frame`` layers, except for
 ``Map_Frame.Projection_and_Grids`` and
 ``Map_Frame.Terrain.Shaded_Relief``, will be included. This behavior can be
-changed with the ``--layers`` option. 
+changed with the ``--layers`` option.
+
+MakeWaypoints
+-------------
+
+Synopsis
+^^^^^^^^
+
+``kotlin MakeWaypointsKt`` [``-latfirst``] *file*
 
+Prompt for long, lat (or, with ``-latfirst``, lat, long) pairs and names and
+create a file containing the specified waypoints. Coordinates are expected to
+be two comma-separated floating-point numbers, with negative values indicating
+locations in the southern or western hemispheres (i.e. the standard way of
+representing coordinates in computer storage).
+
+Basic sanity checks are performed on the coordinates entered.
+
+Notes
+^^^^^
+
+This program is in Kotlin, despite my starting this project in Python, because
+the JVM has a much more concise and simple way (i.e. ``XMLStreamWriter``) for
+producing XML output.
+
+Longitude, not latitude, is first by default because that is the way QGIS
+exports coordinates.