Add Wayland awareness

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index a7f6823a0d84c353d08f4b9428e334fa38731f23..21a9aedc82f5c75299382b3e9d36fb7fffd24201 100644 (file)
--- a/README.md
+++ b/README.md
@@ -256,6 +256,19 @@ kernel parameter `nvidia-drm.modeset` must be set to 1. For example, add a file
 options nvidia_drm modeset=1
 ```
 
+### Wayland
+
+Before running autorandr will check the environment for the `WAYLAND_DISPLAY`
+variable to check if the program is running in a Wayland session. This is to
+avoid issues between usage of xrandr in Wayland environments.
+
+If you need to run autorandr in a Wayland environment, one workaround is to
+unset the `WAYLAND_DISPLAY` variable before running the program, such as:
+
+```
+WAYLAND_DISPLAY= autorandr
+```
+
 ## Changelog
 
 **autorandr 1.13.3**