Skip to content

Commit

Permalink
Change the Linux install instructions to recommend X11 over Wayland
Browse files Browse the repository at this point in the history
See issue #8 comments for the reasoning behind this.
  • Loading branch information
drmfinlay committed Mar 18, 2020
1 parent 7fd6187 commit 504d313
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.semicomplete.com/projects/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:
Expand Down
7 changes: 5 additions & 2 deletions documentation/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.semicomplete.com/projects/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:
Expand Down

0 comments on commit 504d313

Please sign in to comment.