Skip to content

Commit

Permalink
Update Dragonfly's latest documentation
Browse files Browse the repository at this point in the history
Re: #389.

The latest documentation and GitHub README now recommend installing
with 'pip install dragonfly2', for the moment.  Release candidates
for version 1.0.0 are also now mentioned.
  • Loading branch information
drmfinlay committed May 13, 2024
1 parent b08fa83 commit b0a3537
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,18 @@ pip:

.. code:: shell
pip install dragonfly
pip install dragonfly2
If you wish to install the latest release candidate for version 1.0.0,
please run the following command instead:

.. code:: shell
pip install dragonfly2==1.0.0-rc2
These versions are more up-to-date and have fewer requirements. The
documentation for them is available at `Read the Docs (latest)
<http://dragonfly2.readthedocs.org/en/latest/>`_.

If you are installing this on Linux, you will also need to install the
`wmctrl <https://www.freedesktop.org/wiki/Software/wmctrl/>`__, `xdotool
Expand Down
14 changes: 13 additions & 1 deletion documentation/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,24 @@ that the Wayland user switch to X11.

Installation of Dragonfly
----------------------------------------------------------------------------

Dragonfly is a Python package. It can be installed as *dragonfly* using
pip:

.. code:: shell

pip install dragonfly
pip install dragonfly2

If you wish to install the latest release candidate for version 1.0.0,
please run the following command instead:

.. code:: shell

pip install dragonfly2==1.0.0-rc2

These versions are more up-to-date and have fewer requirements. The
documentation for them is available at `Read the Docs (latest)
<http://dragonfly2.readthedocs.org/en/latest/>`_.

Dragonfly can also be installed by cloning this repository or
downloading it from `the releases
Expand Down

0 comments on commit b0a3537

Please sign in to comment.