Added build instructions to README. Changed install-protoc script to clean up after itself.

Author: scottfrederick

README.md

@@ -17,16 +17,98 @@ The library can be used by Java, Groovy, and Scala apps to interact with a Cloud
 
 ## cloudfoundry-maven-plugin
 
-The Cloud Foundry Maven plugin is a plugin for the [Maven build tool](http://maven.apache.org/) that allows you to deploy and manage applications with Maven goals.
+The Cloud Foundry Maven plugin is a plugin for the [Maven build tool](http://maven.apache.org/) that allows you to
+deploy and manage applications with Maven goals.
 
 [Read more](./cloudfoundry-maven-plugin)
 
 ## cloudfoundry-gradle-plugin
 
-The Cloud Foundry Gradle plugin is a plugin for the [Gradle build tool](http://www.gradle.org/) that allows you to deploy and manage applications with Gradle tasks.
+The Cloud Foundry Gradle plugin is a plugin for the [Gradle build tool](http://www.gradle.org/) that allows you to
+deploy and manage applications with Gradle tasks.
 
 [Read more](./cloudfoundry-gradle-plugin)
 
+# Building
+
+## Prerequisites
+
+### Apache Maven
+
+The `cloudfoundry-client-lib` and `cloudfoundry-maven-plugin` components are built with [Apache Maven](http://maven.apache.org/).
+
+### Gradle
+
+The `cloudfoundry-gradle-plugin` component is built with [Gradle](http://www.gradle.org/).
+
+### Protocol Buffer compiler
+
+The `cloudfoundry-client-lib` uses Protocol Buffers to get logs from the Cloud Foundry [loggregator](https://github.com/cloudfoundry/loggregator)
+component. A `protoc` Protocol Buffer compiler is required at build time to compile message specifications. `protoc` version
+2.5.0 is required.
+
+On Linux with `apt`, run the [install-protoc.sh](./bin/install-protoc.sh) script in this repository to compile `protoc` 2.5.0 from source.
+
+On OSX with [homebrew](http://brew.sh/), install `protoc` with this command:
+
+```
+$ brew install protobuf
+```
+
+On Windows, download the [`protoc` binary](https://code.google.com/p/protobuf/downloads/detail?name=protoc-2.5.0-win32.zip),
+unzip it, and put `protoc.exe` in the path.
+
+After installing, run this command and check the output to make sure it is similar to the following:
+
+```
+$ protoc --version
+libprotoc 2.5.0
+```
+
+## Compiling and Packaging
+
+To build `cloudfoundry-client-lib` and `cloudfoundry-maven-plugin`, run the following command from the project root directory:
+
+```
+$ mvn clean install
+```
+
+To build `cloudfoundry-gradle-plugin`, run the following command from the `cloudfoundry-gradle-plugin` sub-directory after
+building `cloudfoundry-client-lib`:
+
+```
+$ gradle clean install
+```
+
+## Running Integration Tests
+
+`cloudfoundry-client-lib` has an extensive set of integration tests which run against a Cloud Foundry service. To execute the
+integration tests, run the following command from the project root directory:
+
+```
+$ mvn -P integration-test clean install -Dccng.target=<endpoint> -Dccng.email=<username> -Dccng.passwd=<password> -Dccng.org=<organization> -Dccng.space=<space>
+```
+
+Following is a complete list of the `-D` parameters that can be passed to the integration test:
+
+| Parameter        | Description                                                     | Required/Optional |
+| ---------        | -----------                                                     | ----------------- |
+| ccng.target      | target Cloud Foundry endpoint (e.g. https://api.run.pivotal.io) | required |
+| ccng.email       | Cloud Foundry username                                          | required |
+| ccng.passwd      | Cloud Foundry password                                          | required |
+| ccng.org         | Cloud Foundry organization to run tests against                 | required |
+| ccng.space       | Cloud Foundry space to run tests against                        | required |
+| ccng.ssl         | trust self-signed certificates from target endpoint             | optional, default is `false` |
+| vcap.mysql.label | label of a MySQL service that can be created                    | optional, default is `cleardb` |
+| vcap.mysql.plan  | plan of a MySQL service that can be created                     | optional, default is `spark` |
+| http.proxyHost   | host name of an HTTP proxy                                      | optional |
+| http.proxyPort   | port of an HTTP proxy                                           | optional |
+
+**Important**
+
+Integration tests should be run against an empty Cloud Foundry space. The integration tests are destructive,
+and will delete any apps, services, routes, and domains existing in the target space.
+
 # Cloud Foundry Resources
 
 _Cloud Foundry Open Source Platform as a Service_

bin/install-protoc.sh

@@ -1,8 +1,11 @@
+#!/bin/sh
 sudo apt-get -y install build-essential
 wget https://protobuf.googlecode.com/files/protobuf-2.5.0.tar.gz
 tar xvfz protobuf-2.5.0.tar.gz
 cd protobuf-2.5.0
 ./configure --prefix=/usr
 make
 sudo make install
-protoc --version
+cd ..
+rm protobuf-2.5.0.tar.gz
+rm -rf protobuf-2.5.0