Added a README for the demo app.

This commit is contained in:
Duncan McGreggor 2012-04-23 10:07:04 -04:00
parent 42cbb39d14
commit 9e4be06b20
1 changed files with 35 additions and 0 deletions

35
demoapp/README.rst Normal file
View File

@ -0,0 +1,35 @@
Running demoapp
===============
Setup
-----
First, you need to create a virtual environment and switch to it::
$ pip install virtualenv
$ virtualenv .venv
$ . .venv/bin/activate
Now, install the demo into the virtual environment::
$ python setup.py install
Usage
-----
With cliff and the demo setup up, you can now play with it.
Here are a list of the commands available::
XXX
Here is some example usage::
XXX
Cleaning Up
-----------
Finally, when done, deactivate your virtual environment::
$ deactivate