aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..20b9131
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# wsct
+
+Set a fixed color temperature on Wayland compositors supporting
+`wlr-gamma-control-unstable-v1`.
+Stripped down version of <https://git.sr.ht/~kennylevinsen/wlsunset> with only the funcionality I need.
+
+# How to build and install
+
+```sh
+meson build
+ninja -C build
+sudo ninja -C build install
+```
+
+# How to use
+
+```sh
+wsct 4500
+```
+
+`wsct` stays running after applying the temperature. The Wayland gamma-control
+protocol restores the original ramps when the client exits, so the process must
+remain alive for the setting to persist.
+
+# Help
+
+Go to #kennylevinsen @ irc.libera.chat to discuss, or use [~kennylevinsen/wlsunset-devel@lists.sr.ht](https://lists.sr.ht/~kennylevinsen/wlsunset-devel)