Update instructions

This commit is contained in:
Eduard Tolosa 2019-03-26 01:45:52 -05:00
parent 2a5c2d4f17
commit 5274bf3bdb

View file

@ -1,6 +1,6 @@
# upcheck
Check ArchLinux available updates and send it via libnotify.
Checker for ArchLinux available updates and send it via libnotify writen in Rust.
# How to install and get it working?
@ -10,10 +10,21 @@ First install [pacman-contrib](https://www.archlinux.org/packages/community/x86_
# pacman -Syu --needed pacman-contrib libnotify
```
Installation is easy, put the `upcheck` script in $HOME/.local/bin/, then put the `upcheck.service` and `upcheck.timer` into $HOME/.config/systemd/user/ and enable/start `upcheck.timer` with the command `systemctl --user enable upcheck.timer && systemctl --user start upcheck.timer`
Installation is easy, put the `bin/upcheck` binary in $HOME/.local/bin/, then put the `upcheck.service` and `upcheck.timer` into $HOME/.config/systemd/user/ and enable/start `upcheck.timer` with the command `systemctl --user enable upcheck.timer && systemctl --user start upcheck.timer`
**Important note**: you need a [notifications server](https://wiki.archlinux.org/index.php/Desktop_notifications#Notification_servers) if you aren't using Cinnamon, Deepin, Enlightenment, GNOME, GNOME Flashback or KDE Plasma.
# Building yourself
If you don't want to use the provide binary, you can compile it following the next commands:
``
$ git clone https://gitlab.com/edu4rdshl/upcheck.git
$ cd upcheck
$ cargo build --release
$ cp target/release/upcheck $HOME/.local/bin/
``
Then continue with installation.
# How it works?
It use the `checkupdates` bash script provided by the `pacman-contrib` package and the `notify-send` binary provided by the `libnotify` package. First, it exec the command `checkupdates` and save the output in a variable, if the variable is not an empty string, mean that there are available updates and then send the variable content using `libnotify`.
@ -26,4 +37,4 @@ It doesn't have any special purpose, it was created only trying to avoid the use
Modify the `upcheck.timer` unit and change the OnUnitActiveSec= option to what you want. See `man 7 systemd.time` for the time specifications.
That is all.
That is all.