diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
| commit | 9e64f600b65d99ea5a83051372372512be698b1b (patch) | |
| tree | 7409d3646ff4a0fa349b8e71daa5959cbde342bf /docs/overview | |
| parent | 4c97ab03825151fd85a875617fde7d0534c9cb72 (diff) | |
| download | cmd2-git-9e64f600b65d99ea5a83051372372512be698b1b.tar.gz | |
Added a walkthrough of constructing a simple application to the overview
For #709
Diffstat (limited to 'docs/overview')
| -rw-r--r-- | docs/overview/index.rst | 3 | ||||
| -rw-r--r-- | docs/overview/summary.rst | 10 |
2 files changed, 9 insertions, 4 deletions
diff --git a/docs/overview/index.rst b/docs/overview/index.rst index 54415a33..831e9bf0 100644 --- a/docs/overview/index.rst +++ b/docs/overview/index.rst @@ -6,10 +6,11 @@ Getting Started :hidden: featuretour + ../examples/example installation integrating alternatives resources - ../examples/quickstart + .. include:: summary.rst diff --git a/docs/overview/summary.rst b/docs/overview/summary.rst index 4145d124..d6d7abb6 100644 --- a/docs/overview/summary.rst +++ b/docs/overview/summary.rst @@ -3,13 +3,17 @@ 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. +application? + 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. +want to add more functionality with very little work? + +``cmd2`` is a powerful python library for built command line applications. Start +here to find out if this library 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:`examples/example:Simple Application` - a sample application showing 5 key features of ``cmd2`` * :ref:`overview/installation:Installation Instructions` - how to install ``cmd2`` and associated optional dependencies * :ref:`overview/integrating:Integrate cmd2 Into Your Project` - adding ``cmd2`` |