annotate docs/overview.rst @ 314:0687bb650118

begin new docs
author catherine@dellzilla
date Wed, 10 Feb 2010 14:07:01 -0500
parents
children
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2 ========
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 Overview
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4 ========
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
6 ``cmd2`` is an extension of cmd_, the Python Standard Library's module for
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
7 creating simple interactive command-line applications.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
8
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
9 ``cmd2`` can be used as a drop-in replacement for cmd_. Simply importing ``cmd2``
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
10 in place of cmd_ will add many features to an application without any further
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
11 modifications.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
12
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
13 Understanding the use of cmd_ is the first step in learning the use of ``cmd2``.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
14 Once you have read the cmd_ docs, return here to learn the ways that ``cmd2``
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
15 differs from cmd_.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
16
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
17 .. _cmd: http://docs.python.org/library/cmd.html