From da39a5211d36a841019a061e928d5eed8747914c Mon Sep 17 00:00:00 2001 From: Louis Dalibard Date: Sat, 31 Aug 2024 13:00:24 +0200 Subject: [PATCH] fix: better documentation --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5fb2589..2939aaa 100644 --- a/README.md +++ b/README.md @@ -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`. \ No newline at end of file +You can configure the software by modifying the values in `~/.config/ontake/hayai/config.yml` (on Linux) and `C:\Users\\AppData\Roaming\ontake\hayai\config.yml` (on Windows) and then restarting `hayai`.