arti/wdisplays
1
0
Fork 0
mirror of https://github.com/artizirk/wdisplays.git synced 2024-11-21 16:30:59 +02:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Jason Francis 2019-08-15 07:39:33 -04:00
parent 27d7067762
commit ff536e196d
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -4,8 +4,8 @@
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, such
as [sway].
compositor that implements the wlr-output-management-unstable-v1 protocol,
including [sway].
![Screenshot](wdisplays.png)
@ -23,5 +23,26 @@ ninja -C build
sudo ninja -C build install
```
# FAQ (Fervently Anticpiated Quandaries)
### What is this?
It's intended to be the Wayland equivalent of an xrandr GUI, like [ARandR].
### Help, I get errors and/or crashes!
Make sure your wlroots and sway are up-to-date. Particularly, you need a git
revision of wlroots from [this commit](https://github.com/swaywm/wlroots/commit/724b5e1b8d742a8429f4431ae1a55d7d26cb92ae)
(or later) or your compositor may crash when adding/removing displays.
Alternatively, you can try to disable the "Show Screen Contents" option.
### I'm using Sway, why aren't my display settings saved when I log out?
Sway, like i3, doesn't save any settings unless you put them in the config
file. See man `sway-output`. If you want to have multiple configurations
depending on the monitors connected, you'll need to use an external program
like [kanshi].
[kanshi]: https://github.com/emersion/kanshi
[sway]: https://github.com/swaywm/sway
[ARandR]: https://christian.amsuess.com/tools/arandr/