README.md

   1 Munter.py
   2 =========
   3
   4 Helps you speed up your tour and trip planning.
   5
   6 Disclaimer
   7 ----------
   8
   9 The time calculations produced by this program are not guaranteed to be
  10 accurate. Any harm or hazard encountered due to blindly trusting these
  11 estimates is your own fault.
  12
  13 Installation
  14 ------------
  15
  16 There is no installation and there are no dependencies external to the Python
  17 standard library.
  18
  19 How to use it
  20 -------------
  21
  22 `./munter.py --help`
  23
  24 My workflow involves planning my tour using tools like ArcGIS or CalTopo. Then,
  25 I take the stats between each leg (distance, vertical gain/loss) of the tour
  26 and run them through Munter.py and thence record its output to my field
  27 notebook.
  28
  29 The rudimentary "GUI" can be directly transferred to e.g. the format used by
  30 SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
  31 (e.g. RitR No. 471).
  32
  33 Future plans
  34 ------------
  35
  36 * Personal "fitness" switch (to help fine tune your estimates based on
  37                                                          your personal fitness level as observed
  38                                                          over time)
  39 * GTK mode
  40 * Use as a Python library from within another project
  41 * Lint it (e.g. therapist)
  42 * Pip?
  43 * Sphinx/autodoc?
  44
  45 Version History
  46 ---------------
  47
  48 - 2.0.0 (Jun 2020)
  49
  50   Packaged for distribution as a standalone program (and library).
  51
  52 - 1.0.2 (Jun 2020)
  53
  54   A few small bugfixes.
  55
  56 - 1.0.1 (Jun 2020)
  57
  58   Add LICENSE and README.
  59
  60 - 1.0.0 (Jun 2020)
  61
  62   First released version. Includes sensible defaults and a rudimentary CLI
  63   "GUI".
  64
  65 - pre-1.0.0 (Mar 2017)
  66
  67   In use privately/internally since 2017.