From 7a15a6a9b4831febe347a387f04f15f878390f95 Mon Sep 17 00:00:00 2001 From: Dane Finlay Date: Wed, 18 Mar 2020 20:26:28 +1100 Subject: [PATCH] Change the Linux install instructions to recommend X11 over Wayland See issue #8 comments for the reasoning behind this. --- README.rst | 7 +++++-- documentation/installation.txt | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 7ca11d43..1ea207de 100644 --- a/README.rst +++ b/README.rst @@ -143,9 +143,12 @@ upload releases to PyPI.org, but everything can still be imported using replace :code:`dragonfly` with :code:`dragonfly2` or remove lines like this altogether. -If you are installing this on X11/Linux, you will also need to install the +If you are installing this on Linux, you will also need to install the `xdotool `__ program for the -``Key`` and ``Text`` actions to work. +``Key`` and ``Text`` actions to work. Please note that Dragonfly is only +fully functional in an X11 session. Input action classes, application +contexts and the ``Window`` class will **not** be functional under Wayland. +It is recommended that Wayland users switch to X11. If you have dragonfly installed under the original *dragonfly* distribution name, you'll need to remove the old version using: diff --git a/documentation/installation.txt b/documentation/installation.txt index 518ddc04..e9531aea 100644 --- a/documentation/installation.txt +++ b/documentation/installation.txt @@ -41,9 +41,12 @@ upload releases to PyPI.org, but everything can still be imported using replace :code:`dragonfly` with :code:`dragonfly2` or remove lines like this altogether. -If you are installing this on X11/Linux, you will also need to install the +If you are installing this on Linux, you will also need to install the `xdotool `__ program for the -``Key`` and ``Text`` actions to work. +``Key`` and ``Text`` actions to work. Please note that Dragonfly is only +fully functional in an X11 session. Input action classes, application +contexts and the ``Window`` class will **not** be functional under Wayland. +It is recommended that Wayland users switch to X11. If you have dragonfly installed under the original *dragonfly* distribution name, you'll need to remove the old version using: