diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index ca5e8870..eba90e0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,6 +30,13 @@ The basic use of ``cmd2`` is identical to that of cmd_. app = App() app.cmdloop() +.. note:: + + The tab-completion capability 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 installing the `gnureadline <https://pypi.python.org/pypi/gnureadline>`_ Python module. + For Windows, we recommend installing the `pyreadline <https://pypi.python.org/pypi/pyreadline>`_ Python module. + Resources --------- |