Implement fitness modifier

[munter.git] / README.md

diff --git a/README.md b/README.md
index 6356009eb9ed5b703f5699ed2ab26d7d97e0e30d..03f49c5d12b0cf893ba6bbeb4f8ac3db39e81a7e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,14 +13,38 @@ 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`
 

+The program supports both imperial and metric, and has four "travel
+modes" at this time: uphill, flat, downhill, bushwhacking.
+
+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.
+
+### 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')`
+
+This will store a value like "3.04095" 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 thence record its output to my field
 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


@@ -40,14 +64,22 @@ Future plans
 * Use as a Python library from within another project
 * Lint it (e.g. therapist)
 * Pip?
 * Use as a Python library from within another project
 * Lint it (e.g. therapist)
 * Pip?

+* Sphinx/autodoc?

 
 Version History
 ---------------
 
 
 Version History
 ---------------
 

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