summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorTerry Howe <terrylhowe@gmail.com>2015-12-08 15:43:06 -0700
committerTerry Howe <terrylhowe@gmail.com>2016-04-23 12:20:44 +0000
commitaa41127ef7987cd5c64d61e6be6c33b502f973ab (patch)
treeaaf6fd68ccfe4034e579dfc1ee89fb23f5b8fffe /README.rst
parentc3f9d6c66524d301a2b4ad6caf2bb8cd711561b4 (diff)
downloadpython-jenkins-job-builder-aa41127ef7987cd5c64d61e6be6c33b502f973ab.tar.gz
python-jenkins-job-builder-aa41127ef7987cd5c64d61e6be6c33b502f973ab.tar.xz
python-jenkins-job-builder-aa41127ef7987cd5c64d61e6be6c33b502f973ab.zip
Change documentation to install from pypi
Change-Id: I46fe46d0af14563b2e87492c2abe1b39ec246714
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 746cda0c..bb280c89 100644
--- a/README.rst
+++ b/README.rst
@@ -9,7 +9,7 @@ similarly configured jobs is easy.
To install::
- $ sudo python setup.py install
+ $ pip install --user jenkins-job-builder
Online documentation:
@@ -29,6 +29,13 @@ Cloning::
git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
+A virtual environment is recommended for development. For example, Jenkins
+Job Builder may be installed from the top level directory::
+
+ $ virtualenv .venv
+ $ source .venv/bin/activate
+ $ pip install -r test-requirements.txt -e .
+
Patches are submitted via Gerrit at:
* https://review.openstack.org/