Merge branch 'release-2.3.0'

[munter.git] / README.md

diff --git a/README.md b/README.md
index 3dc428fea48aaf500c9b2758f0fc74e226ad8c7d..37c92aa449712a11b8f0f69d45ff9016ab09596d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,6 +34,11 @@ 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:
@@ -46,26 +51,39 @@ 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
 ------------
 
-* GTK mode
-* Use as a Python library from within another project
-* Lint it (e.g. therapist)
-* Sphinx/autodoc?
+* Better documentation
 
 Version History
 ---------------
 
+- 2.3.0 (Jul 2020)
+
+  Implement 'auto-start in GUI' feature.
+
+  The program tries to detect whether it was invoked from a terminal or
+  not, and if not, it will automatically switch to GUI mode. Useful for
+  invocation via e.g. dmenu(1).
+
+- 2.2.1 (Jun 2020)
+
+  Complete fixes recommended by pylint(1).
+
+- 2.2.0 (Jun 2020)
+
+  Implement GUI mode.
+
 - 2.1.0 (Jun 2020)
 
   Implement fitness modifier. Make some text changes and other