diff docs/index.rst @ 324:21584174d865

make SHOW TABLES work
author catherine@dellzilla
date Thu, 11 Feb 2010 16:07:24 -0500
parents a08c50b7d3d3
children 49bea7cab179
line wrap: on
line diff
--- a/docs/index.rst	Thu Feb 11 14:46:50 2010 -0500
+++ b/docs/index.rst	Thu Feb 11 16:07:24 2010 -0500
@@ -6,6 +6,21 @@
 Welcome to cmd2's documentation!
 ================================
 
+The basic use of ``cmd2`` is identical to that of cmd_.
+
+1. Create a subclass of ``cmd2.Cmd``.  Define attributes and
+   ``do_*`` methods to control its behavior.  Throughout this documentation,
+   we will assume that you are naming your subclass ``App``::
+   
+     from cmd2 import Cmd
+     class App(Cmd):
+         # customized attributes and methods here
+         
+2. Instantiate ``App`` and start the command loop::
+
+     app = App()
+     app.cmdloop()
+     
 Contents:
 
 .. toctree::