diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 7 | ||||
| -rw-r--r-- | docs/install.rst | 31 |
2 files changed, 33 insertions, 5 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 diff --git a/docs/install.rst b/docs/install.rst index 2c247a3e..b6ee0aff 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,5 +1,4 @@ -========================= Installation Instructions ========================= @@ -138,5 +137,33 @@ Extra requirement for Python 2.7 only If you want to be able to pipe the output of commands to a shell command on Python 2.7, then you will need one additional package installed: - * subprocess32 + * subprocess32gNU + +Extra requirement for macOS +=========================== +macOS comes with the `libedit <http://thrysoee.dk/editline/>`_ library which is similar, but not identical, to GNU Readline. +Tab-completion for ``cmd2`` applications is only tested against GNU Readline. + +There are several ways GNU Readline can be installed within a Python environment on a Mac, detailed in the following subsections. + +gnureadline Python module +------------------------- +Install the `gnureadline <https://pypi.python.org/pypi/gnureadline>`_ Python module which is statically linked against a specific compatible version of GNU Readline:: + + pip install -U gnureadline + +readline via conda +------------------ +Install the **readline** package using the ``conda`` package manager included with the Anaconda Python distribution:: + + conda install readline + +readline via brew +----------------- +Install the **readline** package using the Homebrew package manager (compiles from source):: + + brew install openssl + brew install pyenv + brew install readline +Then use pyenv to compile Python and link against the installed readline |