diff --git a/README.rst b/README.rst index 4aa70d3..dc1b6fd 100644 --- a/README.rst +++ b/README.rst @@ -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: diff --git a/documentation/installation.txt b/documentation/installation.txt index 4431c40..b46d19a 100644 --- a/documentation/installation.txt +++ b/documentation/installation.txt @@ -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 `__ 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 `_ -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