Merge branch 'release-2.3.0'

[munter.git] / README.md

diff --git a/README.md b/README.md
index 32c792f9332d20c64e7c95ab403d492303cab12b..37c92aa449712a11b8f0f69d45ff9016ab09596d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,42 +13,93 @@ estimates is your own fault.
 Installation
 ------------
 
 Installation
 ------------
 

-There is no installation and there are no dependencies external to the Python
-standard library.
+If you use pip, then simply `pip install munter.py`.
+
+If you don't use pip, then download the source code and unpack it into
+its own directory. You can invoke it directly via `python munter.py
+[options]`.

 
 How to use it
 -------------
 
 
 How to use it
 -------------
 

+For detailed information, see:
+

 `./munter.py --help`
 
 `./munter.py --help`
 

-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 thence record its output to my field
-notebook.
+The program supports both imperial and metric, and has four "travel
+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

 
 

-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).
+You can also use Munter.py programmatically from Python, like so:
+
+`import munter`  
+`est = munter.time_calc(distance=3.2, elevation=2300, fitness='slow')`
+
+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.
+
+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
 ------------
 
 
 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?
+* Better documentation

 
 Version History
 ---------------
 
 
 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
+  miscellaneous and minor improvements.
+
+- 2.0.1 (Jun 2020)
+
+  README improvement.
+
+- 2.0.0 (Jun 2020)
+
+  Package for distribution as a standalone program (and library).
+

 - 1.0.2 (Jun 2020)
 
 - 1.0.2 (Jun 2020)
 

-  Packaged for distribution as a standalone program as well as a
-  library. Also contains a few small bugfixes.
+  A few small bugfixes.

 
 - 1.0.1 (Jun 2020)
 
 
 - 1.0.1 (Jun 2020)