diff options
Diffstat (limited to 'docs/overview.rst')
| -rw-r--r-- | docs/overview.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..cb0c80e --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,17 @@ + +======== +Overview +======== + +``cmd2`` is an extension of cmd_, the Python Standard Library's module for +creating simple interactive command-line applications. + +``cmd2`` can be used as a drop-in replacement for cmd_. Simply importing ``cmd2`` +in place of cmd_ will add many features to an application without any further +modifications. + +Understanding the use of cmd_ is the first step in learning the use of ``cmd2``. +Once you have read the cmd_ docs, return here to learn the ways that ``cmd2`` +differs from cmd_. + +.. _cmd: http://docs.python.org/library/cmd.html
\ No newline at end of file |