feat: add documentation

This commit is contained in:
Louis Dalibard 2024-08-25 12:32:04 +02:00
parent c8feff0d7a
commit 002559c9f6
2 changed files with 9 additions and 0 deletions

View File

@ -2,3 +2,12 @@
An EEW system for Linux using JMA data provided by the Wolfx Project.
This software comes with zero guarantee. This software could fail at any time. I made this since there were no better free and open source alternatives for Linux.
# Installation
## Arch
Install the `ontake-hayai-git` package from the AUR.
Enable the service by running: `sudo systemctl enable --now hayai@[username]`
# Configuration
You can configure the software by modifying the values in `~/.config/ontake/hayai/config.yml` and then restarting the service.