commit 41d85183182b3dfc2e89fc5d58474cec65f0c625
parent bfa383d1aa528b6da01aa28b33b2d880bf73c333
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Thu, 16 Sep 2021 16:20:56 +0200
Update Readme
Diffstat:
| M | README.md | | | 34 | +++++++++++++++++++++------------- |
1 file changed, 21 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
## What does it do?
It checks your current IM messages via several CLI clients for different
-plattform and notifies you about potential messages.
+platform and notifies you about potential messages.
Currently supported:
- Telegram via [`telegram-cli`](https://github.com/vysheng/tg)
@@ -15,7 +15,7 @@ Future work (WIP, currently not implemented):
## Why?
Many IM clients, such as the Telegram Desktop client or the Signal Desktop
-client are somewhat ressource intensive, particularly on the CPU, leading to
+client are somewhat resource intensive, particularly on the CPU, leading to
high(er) power consumption. With this lightweight notifier script, you are not
required to have the desktop client running in the background at all times.
@@ -43,24 +43,32 @@ Set it up via commandline:
telegram-cli
```
-## Use IM Notifier
+## Install IM Notifier
-Pull this source directory, and run the Makefile:
+Pull this source directory, and run `debuild`:
```
git pull https://src.jayvii.de/PinePhone/Notifier
cd Notifier
-make install
+debuild
+```
+
+This will create a Debian installation package `.deb`, which you may install
+via:
```
+sudo apt install ../im-notifier_*.deb
+```
+
+Packages are being built automatically by Gitlab-CI:
+https://gitlab.com/jayvii_de/pp-notifier/-/jobs
-This will place `im-notifier.sh` into `~/.local/bin/im-notifier.sh` and
-`im-notifier.desktop` into `~/.config/autostart/im-notifier.desktop`. The
-later makes sure, that the daemon ist started when starting the desktop
-session.
+You can Download the "artifacts", which contain the latest `.deb` version.
-In Order to start the daemon directly after installation, restart your
-current desktop session or run the script manually:
+## Use IM Notifier
+Installing IM-Notifier also creates an App-Icon in your application menu.
+Opening this application will run the daemon in the background. You can start
+this notifier automatically upon login:
```
-# Phosh:
-pkill phosh
+mkdir -p ~/.config/autostart
+cp /usr/share/applications/im-notifier.desktop ~/.config/autostart/
```
