Add -v and "one true source"-ify program name

[munter.git] / README.md

diff --git a/README.md b/README.md
index 7203e84625433b153711d063656ffc7996eafc9e..0e03ac1b06a7d49218f6f79e4438e1b2459c71e9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,48 +27,57 @@ For detailed information, see:
 `./munter.py --help`
 
 The program supports both imperial and metric, and has four "travel
-modes" at this time: uphill, flat, downhill, bushwhacking.
+modes" at this time: uphill, flat, downhill, bushwhacking. It also
+supports a simple fitness modifier: slow, average, fast.
 
 By default, the output will be the time in hours and minutes of the
 specified leg. If you prefer, you can use the `-p` switch to get a
 "prettier" output.
 
+There is also a GUI mode available, based on WxPython, which can be used
+by simply invoking like so:
+
+`./munter.py -g`
+
 ### Use as a library
 
 You can also use Munter.py programmatically from Python, like so:
 
 `import munter`  
-`est = munter.time_calc(3.2, 2300, 'uphill', 'imperial')`
+`est = munter.time_calc(distance=3.2, elevation=2300, fitness='slow')`
 
-This will store a value like "3.04095" in the `est` variable.
+This will store a value like "3.64914" in the `est` variable.
 
 Workflow
 --------
 
-My workflow involves planning my tour using tools like ArcGIS or CalTopo. Then,
-I take the stats between each leg (distance, vertical gain/loss) of the tour
-and run them through Munter.py and record its output to my field
-notebook.
+My workflow involves planning my tour using tools like ArcGIS or
+CalTopo. Then, I take the stats between each leg (distance, vertical
+gain/loss) of the tour and run them through Munter.py and record its
+output to my field notebook.
 
-The rudimentary "GUI" can be directly transferred to e.g. the format used by
-SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
-(e.g. RitR No. 471).
+The text-based "pretty" format can be directly transferred to e.g. the
+format used by SnowPit Technologies' "Avalanche Field Notebook" or your
+own personal format (e.g. RitR No. 471).
 
 Future plans
 ------------
 
-* Personal "fitness" switch (to help fine tune your estimates based on
-                                                        your personal fitness level as observed
-                                                        over time)
-* GTK mode
-* Use as a Python library from within another project
 * Lint it (e.g. therapist)
-* Pip?
 * Sphinx/autodoc?
 
 Version History
 ---------------
 
+- 2.2.0 (Jun 2020)
+
+  Implement GUI mode.
+
+- 2.1.0 (Jun 2020)
+
+  Implement fitness modifier. Make some text changes and other
+  miscellaneous and minor improvements.
+
 - 2.0.1 (Jun 2020)
 
   README improvement.