diff options
author | kotfu <kotfu@kotfu.net> | 2019-07-03 11:23:58 -0600 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-07-03 11:23:58 -0600 |
commit | 51ea4ba9fbcdfc785a5e9d6bafcac69334e535a8 (patch) | |
tree | b9b6aa7273040f5dd9132e94706c91ac3de601fe /docs/overview/summary.rst | |
parent | 11da5ba65a43c63364e702de726a7bf09a1241b4 (diff) | |
download | cmd2-git-51ea4ba9fbcdfc785a5e9d6bafcac69334e535a8.tar.gz |
Revise menu structure
- collapse menu structure in sidebar so not everything is always shown
- updates to Getting Started section
Diffstat (limited to 'docs/overview/summary.rst')
-rw-r--r-- | docs/overview/summary.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/overview/summary.rst b/docs/overview/summary.rst new file mode 100644 index 00000000..4145d124 --- /dev/null +++ b/docs/overview/summary.rst @@ -0,0 +1,19 @@ + +.. _cmd: https://docs.python.org/3/library/cmd.html + +Building a new `REPL <https://en.wikipedia.org/wiki/Read–eval–print_loop>`_ or +`Command Line Interface <https://en.wikipedia.org/wiki/Command-line_interface>`_ +application? ``cmd2`` is a powerful python library to help you get the job done. +Already built an application that uses cmd_ from the python standard library and +want to add more functionality with very little work? Begin here to find out if +``cmd2`` is a good fit for your needs. + +* :ref:`overview/featuretour:Feature Highlights` - a quick tour of a few of the + features in ``cmd2``, for both developers and users +* :ref:`overview/installation:Installation Instructions` - how to install + ``cmd2`` and associated optional dependencies +* :ref:`overview/integrating:Integrate cmd2 Into Your Project` - adding ``cmd2`` + to your project +* :ref:`overview/alternatives:Alternatives` - other python packages that might + meet your needs +* :ref:`overview/resources:Resources` - related links and other materials |