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