diff --git a/README.md b/README.md index 8439a59..88719b5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ 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, -including [sway]. +including [sway]. The goal of this project is to allow precise adjustment of +display settings in kiosks, digital signage, and other elaborate multi-monitor +setups. ![Screenshot](wdisplays.png) @@ -13,6 +15,7 @@ including [sway]. Build requirements are: +- meson - GTK+3 - epoxy - wayland-client @@ -23,6 +26,28 @@ ninja -C build sudo ninja -C build install ``` +Binaries are not available. Only building from source is supported, and only +if you're using wlroots compiled from master. + +# Usage + +Displays can be moved around the virtual screen space by clicking and dragging +them in the preview on the left panel. By default, they will snap to one +another. Hold Shift while dragging to disable snapping. You can click and drag +with the middle mouse button to pan. Zoom in and out either with the buttons on +the top left, or by holding Ctrl and scrolling the mouse wheel. Fine tune your +adjustments in the right panel, then click apply. + +There are some options available by clicking the menu button on the top left: + +- Automatically Apply Changes: Makes it so you don't have to hit apply. Disable + this for making minor adjustments, but be careful, you may end up with an + unusable setup. +- Show Screen Contents: Shows a live preview of the screens in the left panel. + Turn off to reduce energy usage. +- Overlay Screen Names: Shows big names in the corner of all screens for easy + identification. Disable if they get in the way. + # FAQ (Fervently Anticpiated Quandaries) ### What is this? diff --git a/resources/wdisplays.ui b/resources/wdisplays.ui index 9092338..88c2a2b 100644 --- a/resources/wdisplays.ui +++ b/resources/wdisplays.ui @@ -56,7 +56,7 @@ True True app.show-overlay - Show Numbers on Screens + Overlay Screen Names False diff --git a/wdisplays.png b/wdisplays.png index d4c484b..33278fb 100644 Binary files a/wdisplays.png and b/wdisplays.png differ