diff --git a/README.rst b/README.rst index 57b07d9..6a9f4df 100644 --- a/README.rst +++ b/README.rst @@ -13,3 +13,9 @@ Features -------- * TODO + +Notes +----- + +There is no command to run this; rather it can be imported into other +scripts. diff --git a/doc/source/installation.rst b/doc/source/installation.rst index c3130fc..9cb7941 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -2,11 +2,17 @@ Installation ============ -At the command line:: +Clone the repo:: - $ pip install python-storyboardclient + $ git clone git://git.openstack.org/openstack-infra/python-storyboardclient + +Inside the repo, on the command line:: + + $ sudo python setup.py install + $ pip install . Or, if you have virtualenvwrapper installed:: $ mkvirtualenv python-storyboardclient - $ pip install python-storyboardclient + $ sudo python setup.py install + $ pip install .