aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2022-12-23 18:23:19 +0100
committerThomas Voss <mail@thomasvoss.com> 2022-12-23 18:23:19 +0100
commit2a0a255422826bafce10e0c82efbd295bd4c24fa (patch)
tree0e1dcb3a6e14e0839f76744baaf66722ef653632 /README.md
parentabb30c3f03e6beba730777c73e39a42df049f1ab (diff)
Add a READMEv1.0.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
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
+```