From b9e9686c742b4eedc4ea95d5899347f626b43b73 Mon Sep 17 00:00:00 2001 From: Alexander Vasarab Date: Tue, 23 Jun 2020 21:04:06 -0700 Subject: [PATCH 1/1] Update README - To use keyword args in programmatic example - Mention fitness modifier --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d78f814..3dc428f 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,8 @@ For detailed information, see: `./munter.py --help` The program supports both imperial and metric, and has four "travel -modes" at this time: uphill, flat, downhill, bushwhacking. +modes" at this time: uphill, flat, downhill, bushwhacking. It also +supports a simple fitness modifier: slow, average, fast. By default, the output will be the time in hours and minutes of the specified leg. If you prefer, you can use the `-p` switch to get a @@ -38,9 +39,9 @@ specified leg. If you prefer, you can use the `-p` switch to get a You can also use Munter.py programmatically from Python, like so: `import munter` -`est = munter.time_calc(3.2, 2300, 'uphill', 'imperial')` +`est = munter.time_calc(distance=3.2, elevation=2300, fitness='slow')` -This will store a value like "3.04095" in the `est` variable. +This will store a value like "3.64914" in the `est` variable. Workflow -------- -- 2.30.2