Update README.md

pull/1/head
Mason10198 3 years ago
parent e8b7fb92fb
commit 8a4d5d0c36

@ -1,6 +1,6 @@
# SkywarnPlus # SkywarnPlus
SkywarnPlus is an optimized, powerful weather alert system designed for Asterisk/app_rpt repeater controller systems such as [AllStarLink](https://allstarlink.org/) and ~~[HAMVOIP](https://hamvoip.org/)~~ (in progress). It's written in Python and utilizes the new [NWS CAP v1.2 JSON API](https://www.weather.gov/documentation/services-web-api). SkywarnPlus is optimized to be resource-efficient and offers customization options to suit various user needs. SkywarnPlus is an optimized, powerful weather alert system designed for Asterisk/app_rpt repeater controller systems such as [AllStarLink](https://allstarlink.org/) and [HAMVOIP](https://hamvoip.org/). It's written in Python and utilizes the new [NWS CAP v1.2 JSON API](https://www.weather.gov/documentation/services-web-api). SkywarnPlus is optimized to be resource-efficient and offers customization options to suit various user needs.
## Features ## Features
@ -42,7 +42,7 @@ This combination of steps ensures SkywarnPlus provides reliable, timely, and acc
# Installation # Installation
SkywarnPlus is recommended to be installed at the `/usr/local/bin/SkywarnPlus` location on a Debian (AllStarLink) machine. **HAMVOIP is not yet supported due to Python3.5 issues, but is actively being worked on.** SkywarnPlus is recommended to be installed at the `/usr/local/bin/SkywarnPlus` location on Debian (AllStarLink) and Arch (HAMVOIP) machines.
Follow the steps below to install: Follow the steps below to install:
@ -50,18 +50,20 @@ Follow the steps below to install:
Install the required dependencies using the following commands: Install the required dependencies using the following commands:
**Debian** **Debian (AllStarLink)**
```bash ```bash
apt install python3 python3-pip ffmpeg apt install python3 python3-pip ffmpeg
pip3 install requests python-dateutil pydub pip3 install requests python-dateutil pydub
``` ```
<!--
**Arch** **Arch (HAMVOIP)**
```bash ```bash
sudo pacman -S python python-pip ffmpeg pacman -S ffmpeg
wget https://bootstrap.pypa.io/pip/3.5/get-pip.py
python get-pip.py
pip install requests python-dateutil pydub pip install requests python-dateutil pydub
``` ```
-->
2. **Clone the Repository** 2. **Clone the Repository**
Clone the SkywarnPlus repository from GitHub to the `/usr/local/bin` directory: Clone the SkywarnPlus repository from GitHub to the `/usr/local/bin` directory:
@ -94,7 +96,7 @@ Add a crontab entry to call SkywarnPlus on an interval. Open your crontab file u
* * * * * /usr/bin/python3 /usr/local/bin/SkywarnPlus/SkywarnPlus.py * * * * * /usr/bin/python3 /usr/local/bin/SkywarnPlus/SkywarnPlus.py
``` ```
This command will execute SkywarnPlus every minute. This command will execute SkywarnPlus (poll NWS API for data) every minute.
# Configuration # Configuration

Loading…
Cancel
Save

Powered by TurnKey Linux.