From 2a0a255422826bafce10e0c82efbd295bd4c24fa Mon Sep 17 00:00:00 2001 From: Thomas Voss Date: Fri, 23 Dec 2022 18:23:19 +0100 Subject: Add a README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..53aed12 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# lux + +`lux(1)` is a basic command-line utility to query and modify display brightness. +Documentation regarding usage is contained within the `lux(1)` manual page. + +## Installation + +If you're on an arch-based Linux distribution, then you can install lux from the +aur: + +```sh +paru -S lux # The lastest stable release +paru -S lux-git # The most up-to-date release +``` + +Otherwise if you would like to build from source, simply run: + +```sh +git clone git://git.thomasvoss.com/lux.git +cd lux +make +make install +``` -- cgit v1.2.3