summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2021-01-28 20:47:43 -0500
committerGitHub <noreply@github.com>2021-01-28 20:47:43 -0500
commit8268401838167decd02c38f39bd94355333ab077 (patch)
treeea88de7a27c3b71ed1295e96b1c72f260d98747a /docs
parenta09ad27429e9bad2983db7f3ba4e7ab287459cab (diff)
parentd5cebaef06719fdc01eba15e01fb70ef948e05c9 (diff)
downloadcmd2-git-8268401838167decd02c38f39bd94355333ab077.tar.gz
Merge branch 'master' into pr/doc/commands
Diffstat (limited to 'docs')
-rw-r--r--docs/overview/integrating.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst
index db5cb206..041083bc 100644
--- a/docs/overview/integrating.rst
+++ b/docs/overview/integrating.rst
@@ -26,10 +26,13 @@ Windows Considerations
If you would like to use :ref:`features/completion:Completion`, and you want
your application to run on Windows, you will need to ensure you install the
-``pyreadline`` package. Make sure to include the following in your
-``setup.py``::
+``pyreadline3`` or ``pyreadline`` package. Make sure to include the following
+in your ``setup.py``::
install_requires=[
'cmd2>=1,<2',
- ":sys_platform=='win32'": ['pyreadline'],
+ ":sys_platform=='win32'": [
+ "pyreadline ; python_version<'3.8'",
+ "pyreadline3 ; python_version>='3.8'", # pyreadline3 is a drop-in replacement for Python 3.8 and above
+ ],
]