diff --git a/README b/README deleted file mode 100644 index 1d28001..0000000 --- a/README +++ /dev/null @@ -1,66 +0,0 @@ -TL;DR -- To download the latest .deb package: -https://github.com/K2DLS/noaacap/wiki/noaacap - -ABOUT NOAACAP - -This software is written in python 3.4 and has been tested with aprx 2.9.x. -If you are running a version < 2.9.0 you should first update aprx. The current -release may be found at http://thelifeofkenneth.com/aprx/debs/. - -Once you are running aprx >= 2.9, install noaacap: - -Install via sudo dpkg -i noaacap-0.6.deb. Then, to satisfy the dependencies, -run sudo apt-get -f install. - -CONFIGURATION - -Add a beacon section similar to the following to /etc/aprx.conf: - - - -beaconmode both -cycle-size 2m - -beacon via WIDE2-1 \ - srccall N0CALL-13 \ - timeout 20 \ - exec /usr/local/bin/noaacap.py - - - -The timeout was needed on my older and slower single core Raspberry Pi Model B. -The aprx default timeout is 10 seconds and the timeout may not be needed on a -RPi 2 or newer. If you see lots of "BEACON EXEC abnormal close" messages in -aprx.log, then you likely need to add the timeout. - -The program will check for a new alert or update every 2 minutes, but only -send if there is a change. - -Edit /etc/noaacap.conf: - -Do not remove the [noaacap] section header. - -myTZ should be set to the Linux TZ value for the issuing office of your -preferred weather zone. For a complete list of timezones, you may use -the following command: timedatectl list-timezones | grep America. - -myZone should be set to your county code. A list of county codes may be found -at https://alerts.weather.gov/. Only list one county. The program will then -send the alert for all affected zones. You could instead use a zone code if -you want to be more specific. - -myResend should be set to 0 for no message resends or to an interval of your -choosing. If noaacap beacons every 2 minutes, a value of 30 would provide -hourly resends. - -Logging values are 0 (quiet), 1 (informational), and 2 (debug). Logs are -written to the systemd journal. - -USE - -It would be good to hear from users of this software. Please email -k2dls@k2dls.net with the callsign-SSID of your APRS station that is sending -weather alerts via this program. - -Dan Srebnick, K2DLS -09/28/2017 diff --git a/README b/README new file mode 120000 index 0000000..b4986c5 --- /dev/null +++ b/README @@ -0,0 +1 @@ +noaacap/usr/local/share/noaacap/README \ No newline at end of file