go/hayai
1
0
Fork 0
mirror of https://github.com/make-42/hayai.git synced 2024-11-22 16:40:09 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: better documentation

Browse Source
This commit is contained in:
Louis Dalibard 2024-08-31 13:00:24 +02:00 committed by GitHub
parent 77341a87d3
commit da39a5211d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,8 +4,8 @@ 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.
## 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).
You can now use your desktop environment to set the `hayai` command to run automatically at login.
@ -19,5 +19,14 @@ Type=Application
X-KDE-AutostartScript=true
```
## Windows
Clone this repo.
`cd` into it.
Build this project with `go build` (`go` is required).
Set the `hayai.exe` to automatically start with your session.
# Configuration
You can configure the software by modifying the values in `~/.config/ontake/hayai/config.yml` and then restarting `hayai`.
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`.