summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-06-14 20:36:32 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2017-06-14 20:36:32 -0400
commit056ea31581af194971816f4150e4f8c2aa7b000c (patch)
treecebceab6b033e8fe6bde087e6a1a9be395125102 /docs/index.rst
parent63d5be91462d897d8fb37b31802dab464d879c87 (diff)
downloadcmd2-git-056ea31581af194971816f4150e4f8c2aa7b000c.tar.gz
Updated documentation with info on tab completion of file system paths
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 84ba4a92..e89be557 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,7 +35,9 @@ 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 Mac OS X, we recommend using the `Homebrew <https://brew.sh>`_ package manager to install the ``readline`` package.
+ 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 Windows, we recommend installing the `pyreadline <https://pypi.python.org/pypi/pyreadline>`_ Python module.
Resources