X-Git-Url: https://wylark.com/src/munter.git/blobdiff_plain/b2bbb21d18ada3297d03dd9f63eb64a1bf923148..0d989299851a0a122bf6a2bf89b9287356b7cf9e:/README.md?ds=inline

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6356009
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+Munter.py
+=========
+
+Helps you speed up your tour and trip planning.
+
+Disclaimer
+----------
+
+The time calculations produced by this program are not guaranteed to be
+accurate. Any harm or hazard encountered due to blindly trusting these
+estimates is your own fault.
+
+Installation
+------------
+
+There is no installation and there are no dependencies external to the Python
+standard library.
+
+How to use it
+-------------
+
+`./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 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).
+
+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?
+
+Version History
+---------------
+
+- 1.0.2 (Jun 2020)
+
+  Packaged for distribution as a standalone program as well as a
+  library. Also contains a few small bugfixes.
+
+- 1.0.1 (Jun 2020)
+
+  Add LICENSE and README.
+
+- 1.0.0 (Jun 2020)
+
+  First released version. Includes sensible defaults and a rudimentary CLI
+  "GUI".
+
+- pre-1.0.0 (Mar 2017)
+
+  In use privately/internally since 2017.