Update README

[munter.git] / README.md

diff --git a/README.md b/README.md
index 58abc0a860337edeebeaa889860b56b3cd7fd904..3dc428fea48aaf500c9b2758f0fc74e226ad8c7d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,7 +27,8 @@ For detailed information, see:
 `./munter.py --help`
 
 The program supports both imperial and metric, and has four "travel
 `./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
 
 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


@@ -38,16 +39,16 @@ specified leg. If you prefer, you can use the `-p` switch to get a
 You can also use Munter.py programmatically from Python, like so:
 
 `import munter`  
 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
 
 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 thence record its output to my field
+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
 notebook.
 
 The rudimentary "GUI" can be directly transferred to e.g. the format used by


@@ -57,25 +58,26 @@ SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
 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)
 * GTK mode
 * Use as a Python library from within another project
 * Lint it (e.g. therapist)

-* Pip?

 * Sphinx/autodoc?
 
 Version History
 ---------------
 
 * Sphinx/autodoc?
 
 Version History
 ---------------
 

+- 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)
 
 - 2.0.1 (Jun 2020)
 
   README improvement.
 
 - 2.0.0 (Jun 2020)
 

-  Packaged for distribution as a standalone program (and library).
+  Package for distribution as a standalone program (and library).

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