summaryrefslogtreecommitdiffstats
path: root/desktop/wdisplays/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/wdisplays/README')
-rw-r--r--desktop/wdisplays/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/desktop/wdisplays/README b/desktop/wdisplays/README
new file mode 100644
index 0000000000..bce217fa1e
--- /dev/null
+++ b/desktop/wdisplays/README
@@ -0,0 +1,12 @@
+wdisplays (graphical display config for Wayland)
+
+wdisplays is a graphical application for configuring displays in
+Wayland compositors. It borrows some code from kanshi. It should work
+in any compositor that implements the wlr-output-management-unstable
+-v1 protocol. Compositors that are known to support the protocol are
+Sway and Wayfire. The goal of this project is to allow precise
+adjustment of display settings in kiosks, digital signage, and other
+elaborate multi-monitor setups.
+
+Optional Dependency: "scour", if found it will include in the build
+automatically.