Skip to content

Commit b0a3537

Browse files
committed
Update Dragonfly's latest documentation
Re: dictation-toolbox#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.
1 parent b08fa83 commit b0a3537

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.rst

+12-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,18 @@ pip:
140140

141141
.. code:: shell
142142
143-
pip install dragonfly
143+
pip install dragonfly2
144+
145+
If you wish to install the latest release candidate for version 1.0.0,
146+
please run the following command instead:
147+
148+
.. code:: shell
149+
150+
pip install dragonfly2==1.0.0-rc2
151+
152+
These versions are more up-to-date and have fewer requirements. The
153+
documentation for them is available at `Read the Docs (latest)
154+
<http://dragonfly2.readthedocs.org/en/latest/>`_.
144155

145156
If you are installing this on Linux, you will also need to install the
146157
`wmctrl <https://www.freedesktop.org/wiki/Software/wmctrl/>`__, `xdotool

documentation/installation.txt

+13-1
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,24 @@ that the Wayland user switch to X11.
4747

4848
Installation of Dragonfly
4949
----------------------------------------------------------------------------
50+
5051
Dragonfly is a Python package. It can be installed as *dragonfly* using
5152
pip:
5253

5354
.. code:: shell
5455

55-
pip install dragonfly
56+
pip install dragonfly2
57+
58+
If you wish to install the latest release candidate for version 1.0.0,
59+
please run the following command instead:
60+
61+
.. code:: shell
62+
63+
pip install dragonfly2==1.0.0-rc2
64+
65+
These versions are more up-to-date and have fewer requirements. The
66+
documentation for them is available at `Read the Docs (latest)
67+
<http://dragonfly2.readthedocs.org/en/latest/>`_.
5668

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

0 commit comments

Comments
 (0)