You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+84-2Lines changed: 84 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,98 @@ The library can be used by Java, Groovy, and Scala apps to interact with a Cloud
17
17
18
18
## cloudfoundry-maven-plugin
19
19
20
-
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.
20
+
The Cloud Foundry Maven plugin is a plugin for the [Maven build tool](http://maven.apache.org/) that allows you to
21
+
deploy and manage applications with Maven goals.
21
22
22
23
[Read more](./cloudfoundry-maven-plugin)
23
24
24
25
## cloudfoundry-gradle-plugin
25
26
26
-
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.
27
+
The Cloud Foundry Gradle plugin is a plugin for the [Gradle build tool](http://www.gradle.org/) that allows you to
28
+
deploy and manage applications with Gradle tasks.
27
29
28
30
[Read more](./cloudfoundry-gradle-plugin)
29
31
32
+
# Building
33
+
34
+
## Prerequisites
35
+
36
+
### Apache Maven
37
+
38
+
The `cloudfoundry-client-lib` and `cloudfoundry-maven-plugin` components are built with [Apache Maven](http://maven.apache.org/).
39
+
40
+
### Gradle
41
+
42
+
The `cloudfoundry-gradle-plugin` component is built with [Gradle](http://www.gradle.org/).
43
+
44
+
### Protocol Buffer compiler
45
+
46
+
The `cloudfoundry-client-lib` uses Protocol Buffers to get logs from the Cloud Foundry [loggregator](https://github.com/cloudfoundry/loggregator)
47
+
component. A `protoc` Protocol Buffer compiler is required at build time to compile message specifications. `protoc` version
48
+
2.5.0 is required.
49
+
50
+
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.
51
+
52
+
On OSX with [homebrew](http://brew.sh/), install `protoc` with this command:
53
+
54
+
```
55
+
$ brew install protobuf
56
+
```
57
+
58
+
On Windows, download the [`protoc` binary](https://code.google.com/p/protobuf/downloads/detail?name=protoc-2.5.0-win32.zip),
59
+
unzip it, and put `protoc.exe` in the path.
60
+
61
+
After installing, run this command and check the output to make sure it is similar to the following:
62
+
63
+
```
64
+
$ protoc --version
65
+
libprotoc 2.5.0
66
+
```
67
+
68
+
## Compiling and Packaging
69
+
70
+
To build `cloudfoundry-client-lib` and `cloudfoundry-maven-plugin`, run the following command from the project root directory:
71
+
72
+
```
73
+
$ mvn clean install
74
+
```
75
+
76
+
To build `cloudfoundry-gradle-plugin`, run the following command from the `cloudfoundry-gradle-plugin` sub-directory after
77
+
building `cloudfoundry-client-lib`:
78
+
79
+
```
80
+
$ gradle clean install
81
+
```
82
+
83
+
## Running Integration Tests
84
+
85
+
`cloudfoundry-client-lib` has an extensive set of integration tests which run against a Cloud Foundry service. To execute the
86
+
integration tests, run the following command from the project root directory:
0 commit comments