Add readme.

2026-09-12 11:12:05 -05:00
parent 00a90d56dc
commit 8337ed478d
1 changed files with 37 additions and 0 deletions
@@ -0,0 +1,37 @@
+# ASMR
+ASMR: Automatic S-Meter Reader
+
+This program reads location from a GPS dongle and the S-Meter from a
+transceiver via a serial port and stores the results in a CSV file
+so you can run analysis in another program.
+
+Inspired by "RFIM" by W4DD and written in Rust.
+(add a link here to W4DD's RFI materials)
+
+# Use Cases
+- Drive a route and measure variation in noise level, to determine local noise sources
+- Record noise level at a fixed location over time, to determine temporal noise patterns
+- Some combination of the two
+
+# Help
+```
+asmr --help
+
+ASMR: Automatic S-Meter Reader
+
+Usage: asmr [OPTIONS]
+
+Options:
+  -r, --rig <RIG>    Output file path [default: qmx]
+  -c, --com <COM>    Rig COM port
+  -g, --gps <GPS>    GPS COM port
+  -o, --file <FILE>  Output file path
+  -f, --freq <FREQ>  Frequency
+  -w, --wait <WAIT>  Seconds to wait between measurements [default: 5]
+  -h, --help         Print help
+  -V, --version      Print version
+  ```
+
+  # Contact
+  - [@W1CDN@mastodon.radio](https://mastodon.radio/@W1CDN)
+  - admin@w1cdn.net