From ef0a000203989c8a902bca6fcde0db8e4247be2c Mon Sep 17 00:00:00 2001 From: Tim Segers Date: Wed, 5 Oct 2022 00:32:56 +0200 Subject: Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6edf585..ac06044 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # opendeco -Implementation of Buhlmann ZH-L16 with Gradient Factors +```Usage: opendeco [OPTION...] +Implementation of Buhlmann ZH-L16 with Gradient Factors: + + -d, --depth=NUMBER Set the depth of the dive in meters + -t, --time=NUMBER Set the time of the dive in minutes + -g, --gas=STRING Set the bottom gas used during the dive, defaults + to Air + -l, --gflow=NUMBER Set the gradient factor at the first stop, + defaults to 30 + -h, --gfhigh=NUMBER Set the gradient factor at the surface, defaults + to 75 + -G, --decogasses=LIST Set the gasses available for deco + -?, --help Give this help list + --usage Give a short usage message + -V, --version Print program version + +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. + +Examples: + + ./opendeco -d 18 -t 60 -g Air + ./opendeco -d 30 -t 60 -g EAN32 + ./opendeco -d 40 -t 120 -g 21/35 -l 20 -h 80 --decogasses Oxygen,EAN50 + +Report bugs to <~tsegers/opendeco@lists.sr.ht>. +``` -- cgit v1.2.3-70-g09d2