diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
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 +``` |