diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-01-30 23:56:07 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-01-30 23:56:07 -0500 |
| commit | b66837ed3a11bbee7eb98da8b95e0f58eec533bf (patch) | |
| tree | ecee4400982c272ee654fa2ffc617402598f1a2e /docs/index.rst | |
| parent | 450b7b37ef92fa529d07c9d348aaae4a5c036f9f (diff) | |
| download | cmd2-git-b66837ed3a11bbee7eb98da8b95e0f58eec533bf.tar.gz | |
Added a couple notes in the docs:
1) Note about needing GNU Readline or equivalent for tab-completion to work
2) Note about behavior occurring when and empty line is entered is different from parent cmd module
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 --------- |