From 9902cb2c6447e58ef12438ac711addc192b8f1f5 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Wed, 21 Mar 2018 14:41:30 -0400 Subject: Added back in preference for gnureadline if it is present Now that the crash bug in the gnureadline Python module which statically links against a compatible version of GNU Readline has been fixed for macOS, we added back in the top-level import boilerplate to prefer it if it is available. Also updated some documentation in relation to getting readline installed for macOS. --- docs/index.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') 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 `_ 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 `_ 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 `_ package manager can be used to to install the ``readline`` package. For Windows, we recommend installing the `pyreadline `_ Python module. Resources -- cgit v1.2.1