hayai/README.md

33 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2024-08-25 12:16:44 +02:00
# hayai
An EEW system for Linux using JMA data provided by the Wolfx Project.
2024-08-25 12:19:07 +02:00
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.
2024-08-25 12:32:04 +02:00
# Installation
2024-08-31 13:00:24 +02:00
## Linux
Install the `ontake-hayai-git` package from the AUR if on Arch. For other distros you can just build `hayai` from source with `go build` (only `go` is required).
2024-08-25 12:32:04 +02:00
2024-08-25 12:46:36 +02:00
You can now use your desktop environment to set the `hayai` command to run automatically at login.
2024-08-25 12:32:04 +02:00
2024-08-25 12:53:52 +02:00
For KDE that means creating the `.config/autostart/hayai.desktop` file containing:
```
[Desktop Entry]
Exec=/usr/bin/hayai
Name=Hayai
Comment=An EEW system for Linux using JMA data provided by the Wolfx Project.
Type=Application
X-KDE-AutostartScript=true
```
2024-08-31 13:00:24 +02:00
## Windows
Clone this repo.
`cd` into it.
2024-08-31 13:05:29 +02:00
Build this project with `go build -ldflags -H=windowsgui` (`go` is required).
2024-08-31 13:00:24 +02:00
2024-08-31 13:07:41 +02:00
Set the `hayai.exe` to automatically start with your session (by adding a shortcut to it to `C:\Users\<User>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup`.
2024-08-31 13:00:24 +02:00
2024-08-25 12:32:04 +02:00
# Configuration
2024-08-31 13:00:24 +02:00
You can configure the software by modifying the values in `~/.config/ontake/hayai/config.yml` (on Linux) and `C:\Users\<User>\AppData\Roaming\ontake\hayai\config.yml` (on Windows) and then restarting `hayai`.