Skip to content

Commit

Permalink
Merge pull request #514 from Akasurde/master
Browse files Browse the repository at this point in the history
Update index.rst
  • Loading branch information
lechat committed Mar 16, 2017
2 parents d1c2cb7 + 0e756f8 commit 9e204c3
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion doc/source/index.rst
Expand Up @@ -133,19 +133,30 @@ Extending and Improving JenkinsAPI
JenkinsAPI is a pure-python project and can be improved with almost any programmer's text-editor or IDE. I'd recomend the following project layout which has been shown to work with both SublimeText2 and Eclipse/PyDev
* Make sure that pip and virtualenv are installed on your computer. On most Linux systems these can be installed directly by the OS package-manager.
* Create a new virtualenv for the project::
virtualenv jenkinsapi
* Change to the new directory and check out the project code into the **src** subdirectory
* Change to the new directory and check out the project code into the **src** subdirectory::
cd jenkinsapi
git clone https://github.com/salimfadhley/jenkinsapi.git src
* Activate your jenkinsapi virtual environment::
cd bin
source activate
* Install the jenkinsapi project in 'developer mode' - this step will automatically download all of the project's dependancies::
cd ../src
python setup.py develop
* Test the project - this step will automatically download and install the project's test-only dependancies. Having these installed will be helpful during development::
python setup.py test
* Set up your IDE/Editor configuration - the **misc** folder contains configuration for Sublime Text 2. I hope in time that other developers will contribute useful configurations for their favourite development tools.
Testing
Expand Down

0 comments on commit 9e204c3

Please sign in to comment.