Add a link to Ubuntu and Debian package to README

This commit is contained in:
Konstantin Pereiaslov
2023-05-16 08:27:29 +03:00
committed by GitHub
parent 38984cfedc
commit f68bab3ed1

View File

@@ -11,14 +11,18 @@ It then checks once per second if user activity has resumed, and once it is, pau
runwhenidle uses XScreenSaverQueryInfo() to check when last user activity happened therefore a running X server is required.
Wayland is not currently supported.
## Installation
**Ubuntu and Debian**: Download the deb file attached to the [latest release](https://github.com/perk11/runwhenidle/releases/latest).
Other Distros: You will need to compile runwhenidle yourself. AUR package is planned.
## Compiling
Make sure you have `gcc`, `make` and `libxss-dev` installed. Run `make release`. This should produce a binary file `runwhenidle` in the project directory.
If you want to install it system-wide, run `sudo make install` or simply `sudo cp ./runwhenidle /usr/bin`.
I will package this for popular distros in case there is demand.
## Usage
runwhenidle [--timeout|-t timeout_value_in_seconds] [--verbose|-v] [--quiet|-q] shell_command_to_run
@@ -47,4 +51,4 @@ Make sure you have docker installed and run:
make debian-package
The .deb file will be generated in `package-build/` directory.
The .deb file will be generated in `package-build/` directory.