Update docs.

This commit is contained in:
Eduard Tolosa 2019-03-30 16:32:43 -05:00
commit 90f27c438f
4 changed files with 23 additions and 2 deletions

0
Images/.gitkeep Normal file
View file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View file

@ -1,9 +1,15 @@
# upcheck
Checker for ArchLinux available updates and send it via notify-rust.
Checker and notifier for ArchLinux available updates writen in Rust that's totally Desktop/WM environment independent.
# How to install and get it working?
**Using AUR package:**
Install the [upcheck](https://aur.archlinux.org/packages/upcheck/) package and enable/start the `upcheck.timer` user unit with `systemctl --user enable upcheck.timer && systemctl --user start upcheck.timer`
**Manually:**
First install [pacman-contrib](https://www.archlinux.org/packages/community/x86_64/pacman-contrib/) from ArchLinux repos:
```
@ -11,6 +17,7 @@ First install [pacman-contrib](https://www.archlinux.org/packages/community/x86_
```
**Withouth systemd service:**
<<<<<<< HEAD
Put the bin/upcheck binary in $HOME/.local/bin/ or /usr/bin and then execute upcheck with these parameters:
``````
upcheck <N time in minutes> # Check for updates every N minutes.
@ -22,6 +29,9 @@ Install the [upcheck](https://aur.archlinux.org/packages/upcheck/) package.
**Manually for user only:**
Installation is easy, put the `bin/upcheck` binary in $HOME/.local/bin/, put the `upcheck.service` into $HOME/.config/systemd/user/. **Edit** the `upcheck.service` file in the *ExecStart=* section pointing to the `upcheck` executable path and finally enable/start `upcheck.service` with the command `systemctl --user enable upcheck.service && systemctl --user start upcheck.service`
=======
Installation is easy, put the `bin/upcheck` binary in the /usr/bin/ system directory, then put the `upcheck.service` and `upcheck.timer` into $HOME/.config/systemd/user/ and finally enable/start the `upcheck.timer` unit with the command `systemctl --user enable upcheck.timer && systemctl --user start upcheck.timer`
>>>>>>> 7dda82125008cbff356e0486f44e3c33f30129f8
**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.
@ -54,4 +64,15 @@ Example:
```ExecStart=/usr/bin/upcheck 90 # Execute upcheck every 90 minutes.```
That is all.
# Screenshots
Here's a couple of screenshots of upcheck in action:
Updates available:
![](Images/2019-03-27-145536-sechacklabs.png)
No updates available:
![](Images/2019-03-27-150913-sechacklabs.png)