From 002559c9f6d293a78d1606de77b0b659a08abfcd Mon Sep 17 00:00:00 2001 From: Louis Dalibard Date: Sun, 25 Aug 2024 12:32:04 +0200 Subject: [PATCH] feat: add documentation --- README.md | 9 +++++++++ pkg/{hayai.service => hayai@.service} | 0 2 files changed, 9 insertions(+) rename pkg/{hayai.service => hayai@.service} (100%) diff --git a/README.md b/README.md index 879c8d3..0489353 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file diff --git a/pkg/hayai.service b/pkg/hayai@.service similarity index 100% rename from pkg/hayai.service rename to pkg/hayai@.service