Added a bit more to the README.

This commit is contained in:
Duncan McGreggor 2012-04-23 10:32:14 -04:00
parent 3a533e4f3f
commit e8e7404eb1
1 changed files with 23 additions and 9 deletions

View File

@ -9,23 +9,23 @@ First, you need to create a virtual environment and activate it.
::
$ pip install virtualenv
$ virtualenv .venv
$ . .venv/bin/activate
(.venv)$
$ pip install virtualenv
$ virtualenv .venv
$ . .venv/bin/activate
(.venv)$
Next, install ``cliff`` in the environment.
::
(.venv)$ python setup.py install
(.venv)$ python setup.py install
Now, install the demo application into the virtual environment.
::
(.venv)$ cd demoapp
(.venv)$ python setup.py install
(.venv)$ cd demoapp
(.venv)$ python setup.py install
Usage
-----
@ -36,6 +36,20 @@ To see a list of commands availble, run::
(.venv)$ cliffdemo --help
One of the available commands is "simple" and running it
::
(.venv)$ cliffdemo simple
produces the following
::
sending greeting
hi!
To see help for an individual command, include the command name on the
command line::
@ -46,5 +60,5 @@ Cleaning Up
Finally, when done, deactivate your virtual environment::
(.venv)$ deactivate
$
(.venv)$ deactivate
$