Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
- Mention a possible dragonfly2 migration issue.
- Make README and installation.txt file use the same code-block
  style.
  • Loading branch information
drmfinlay committed Nov 7, 2018
1 parent 4407392 commit a8a4cbc
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 16 deletions.
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ pip:
The distribution name has been changed to *dragonfly2* in order to
upload releases to PyPI.org, but everything can still be imported using
*dragonfly*.
*dragonfly*. If you use any grammar modules that include something like
:code:`pkg_resources.require("dragonfly >= 0.6.5")`, you will need to either
replace :code:`dragonfly` with :code:`dragonfly2` or remove lines like this
altogether.

If you have dragonfly installed under the original *dragonfly*
distribution name, you'll need to remove the old version using:
Expand Down
38 changes: 23 additions & 15 deletions documentation/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,35 @@ To be able to use the dragonfly, you will need the following:

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

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

.. code:: shell

pip install dragonfly2

The distribution name has been changed to *dragonfly2* in order to
upload releases to PyPI.org, but everything can still be imported using
*dragonfly*. If you use any grammar modules that include something like
:code:`pkg_resources.require("dragonfly >= 0.6.5")`, you will need to either
replace :code:`dragonfly` with :code:`dragonfly2` or remove lines like this
altogether.

If you have dragonfly installed under the original *dragonfly*
distribution name, you'll need to remove the old version using:

pip install dragonfly2
.. code:: shell

The distribution name has been changed to *dragonfly2* in order to upload
releases to PyPI.org, but everything can still be imported using
*dragonfly*.
pip uninstall dragonfly

If you have dragonfly installed under the original *dragonfly* distribution
name, you'll need to remove the old version using::
pip uninstall dragonfly
Dragonfly can also be installed by cloning this repository or
downloading it from `the releases
page <https://github.com/Danesprite/dragonfly/releases>`__ and running
the following (or similar) command in the project's root directory:

Dragonfly can also be installed by cloning this repository or downloading it
from `the releases page <https://github.com/Danesprite/dragonfly/releases>`_
and running the following (or similar) command in the project's root
directory::
.. code:: shell

python setup.py install
python setup.py install


Installation for Dragon NaturallySpeaking
Expand Down

0 comments on commit a8a4cbc

Please sign in to comment.