summaryrefslogtreecommitdiff
path: root/docs/overview/summary.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/overview/summary.rst')
-rw-r--r--docs/overview/summary.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/overview/summary.rst b/docs/overview/summary.rst
new file mode 100644
index 00000000..9285014c
--- /dev/null
+++ b/docs/overview/summary.rst
@@ -0,0 +1,22 @@
+
+.. _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?
+
+Already built an application that uses cmd_ from the python standard library
+and want to add more functionality with very little work?
+
+``cmd2`` is a powerful python library for building command line applications.
+Start here to find out if this library is a good fit for your needs.
+
+* :ref:`overview/installation:Installation Instructions` - how to install
+ ``cmd2`` and associated optional dependencies
+* :ref:`examples/first_app:First Application` - a sample application showing 8
+ key features of ``cmd2``
+* :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