more doc tweaks

diff --git a/doc/source/index.rst b/doc/source/index.rst
index e85fdf3..8a24259 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -32,11 +32,7 @@ Egg-files for this project are hosted on PyPi. Most Python users should be able
 
 Most users can do the following:
 
-    easy_install jenkinsapi
-
-If you'd like to install in multi-version mode:
-
-    easy_install -m jenkinsapi
+    pip install jenkinsapi
 
 Project Authors
 ===============
@@ -45,7 +41,37 @@ Project Authors
  * Ramon van Alteren (ramon@vanalteren.nl) 
  * Ruslan Lutsenko (ruslan.lutcenko@gmail.com) 
 
-
+Plus many others, please see the README file for a more complete list of contributors and how to contact them.
+
+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
+       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
+-------
+
+The project maintainers welcome any code-contributions. Please conside the following when you contribute code back to the project:
+
+ * All contrubutions should come as github pull-requests. Please do not send code-snippets in email or as attachments to issues.
+ * Please take a moment to clearly describe the intended goal of your pull-request.
+ * Please ensure that any new feature is covered by a unit-test
 
 Package Contents
 ================