aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..556b5c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# wiz - Wayland Is ZZZing
+wiz is meant to be a "suckless" implementation of the Idle Notify protocol. This
+means that it is kept as minimal as possible without sacrificing performance
+or functionality.
+## Building wiz
+wiz requires the following dependencies:
+```
+wayland
+wayland-protocols (compile-time only)
+pkg-config (compile-time only)
+```
+Install these (and their `-devel` versions if your distro has separate
+development packages) and run `make`.
+## Configuration
+To change idle events modify `config.h`, and recompile. Additionally you can modify
+the `killchild` option to send SIGINTs to old children.
+## Acknowledgements
+This project would not have been possible without the following project(s):
+- swaybg for showing how to implement the Idle Notify protocol