aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpux <pux@pux.dom>2021-03-22 00:52:34 +0100
committerpux <pux@pux.dom>2021-03-22 00:52:34 +0100
commit89fb2f470b08068a8578e75fd093bc62493ec413 (patch)
tree8e05f799d388e19cd5b7075f0f05fecda2590b2c
parent27cefd13f48384ce88bb60ee4b59e6f4189508cc (diff)
downloadcalctenna-89fb2f470b08068a8578e75fd093bc62493ec413.tar.gz
calctenna-89fb2f470b08068a8578e75fd093bc62493ec413.tar.bz2
calctenna-89fb2f470b08068a8578e75fd093bc62493ec413.zip
update README after code change
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0324d37..d37a778 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,22 @@
## Calculate dipole antenna leg length
```text
-usage: calctenna.py [-h] -f [frequency] [-V [velocity_factor]] [-q]
+usage: calctenna.py [-h] [-V velocity_factor] [-q] [-t] [frequency]
+
+positional arguments:
+ frequency desired frequency in Hz (e.g. 144800000 or 433e6, ...)
optional arguments:
-h, --help show this help message and exit
- -f [frequency], --frequency [frequency]
- desired frequency in Hz (e.g. 144800000 or 433e6, ...)
- -V [velocity_factor], --velocity-factor [velocity_factor]
+ -V velocity_factor, --velocity-factor velocity_factor
-q, --quiet print only result
+ -t, --tests run unit tests and exit
```
### Example output
```text
-$ calctenna.py -f 104e6
+$ calctenna.py 104e6
Desired Frequency: 104e6 Hz
Wavelength: 2.883 m
Wavelength / 2: 1.441 m
in each repos: see "about"-tab (if existing) for more details / README.
mailto contact at omeckman dot net
all timestamps in UTC (German winter time: UTC+01:00, summer time: UTC+02:00)
dark theme is a modded version of: https://gist.github.com/Yoplitein/f4b671a2ec70c9e743fa