summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 2f2a8dad..b034dafd 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,9 +35,10 @@ The basic use of ``cmd2`` is identical to that of cmd_.
The tab-completion feature provided by cmd_ relies on underlying capability provided by GNU readline or an
equivalent library. Linux distros will almost always come with the required library installed.
- For macOS, we recommend using the `Homebrew <https://brew.sh>`_ package manager to install the ``readline`` package;
- alternatively for macOS the ``conda`` package manager that comes with the Anaconda Python distro can be used to
- install ``readline`` (preferably from conda-forge).
+ For macOS, we recommend using the `gnureadline <https://pypi.python.org/pypi/gnureadline>`_ Python module which includes
+ a statically linked version of GNU readline. Alternatively on macOS the ``conda`` package manager that comes
+ with the Anaconda Python distro can be used to install ``readline`` (preferably from conda-forge) or the
+ `Homebrew <https://brew.sh>`_ package manager can be used to to install the ``readline`` package.
For Windows, we recommend installing the `pyreadline <https://pypi.python.org/pypi/pyreadline>`_ Python module.
Resources