From c0a604b432a8769c208d873eff40e218aeb1a980 Mon Sep 17 00:00:00 2001 From: Zara Date: Tue, 29 Mar 2016 17:53:46 +0000 Subject: [PATCH] Update Docs The installation instructions were incorrect; they advised the user to install a package via pip that was not registered in pypi. This patch changes the installation instructions to ones that work. To avoid confusion, this patch also notes that the client does not run via a command, but can just be imported into other scripts. Change-Id: If34a26dc78641daf0be90dab4a7f788dc72db4bb --- README.rst | 6 ++++++ doc/source/installation.rst | 12 +++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) 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 .