Add LICENSE and README

[munter.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..7581549
--- /dev/null
+++ b/README
@@ -0,0 +1,56 @@
+=========
+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.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.