Add LICENSE and README v1.0.1
authorAlexander Vasarab <alexander@wylark.com>
Sat, 6 Jun 2020 20:53:25 +0000 (13:53 -0700)
committerAlexander Vasarab <alexander@wylark.com>
Sat, 6 Jun 2020 20:53:25 +0000 (13:53 -0700)
LICENSE [new file with mode: 0644]
README [new file with mode: 0644]

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..c3e94b8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2020 Alexander Vasarab, WYLARK MOUNTAINEERING LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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.