mirror of
https://github.com/make-42/hayai.git
synced 2024-11-10 04:11:37 +01:00
fix: better documentation
This commit is contained in:
parent
77341a87d3
commit
da39a5211d
15
README.md
15
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.
|
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
|
# Installation
|
||||||
## Arch
|
## Linux
|
||||||
Install the `ontake-hayai-git` package from the AUR.
|
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.
|
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
|
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
|
# 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`.
|
||||||
|
Loading…
Reference in New Issue
Block a user