Skip to content

Commit 84f8e43

Browse files
authored
Merge pull request #12 from cicsdev/aj-readme
readme build section update
2 parents cea3df1 + ce69ed4 commit 84f8e43

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ You can build the sample using an IDE of your choice, or you can build it from t
5656

5757
For an IDE, taking Eclipse as an example, the plug-ins for Gradle *buildship* and Maven *m2e* will integrate with the "Run As..." capability, allowing you to specify a specific version of your chosen build tool.
5858

59-
The required build-tasks are typically `clean build` for Gradle and `clean verify` for Maven. Once run, Gradle will generate a WAR file in the `build/libs` directory, while Maven will generate it in the `target` directory.
60-
6159
> [!NOTE]
6260
> If you import the project to your IDE, you might experience local project compile errors. To resolve these errors you should run a tooling refresh on that project. For example, in Eclipse: right-click on "Project", select "Gradle -> Refresh Gradle Project", **or** right-click on "Project", select "Maven -> Update Project...".
6361
@@ -70,39 +68,32 @@ Import the projects into CICS Explorer using File → Import → General &
7068
> [!NOTE]
7169
> If using the egit client, you can just clone the repo and tick the button to import all projects.
7270
73-
### Gradle (command line)
74-
75-
Run the following in a local command prompt:
76-
77-
```shell
78-
gradle clean build
79-
```
80-
81-
This creates a WAR file inside the `cics-java-liberty-link-app/build/libs` directory and a CICS bundle ZIP file inside the `cics-java-liberty-link-bundle/build/distribution` directory.
71+
### Building with Gradle
8272

83-
The JVM server the CICS bundle is targeted at is controlled through the `cics.jvmserver` property, defined in the [`cics-java-liberty-link-bundle/build.gradle`](cics-java-liberty-link-bundle/build.gradle) file, or on the command line:
73+
A WAR file is created inside the `cics-java-liberty-link-app/build/libs` directory and a CICS bundle ZIP file inside the `cics-java-liberty-link-bundle/build/distribution` directory.
8474

85-
```shell
86-
gradle clean build -Pcics.jvmserver=MYJVM
87-
```
88-
89-
### Maven (command line)
75+
The JVM server the CICS bundle is targeted at is controlled through the `cics.jvmserver` property, defined in the [`cics-java-liberty-link-bundle/build.gradle`](cics-java-liberty-link-bundle/build.gradle) file, or alternatively can be set on the command line:
9076

77+
| Tool | Command |
78+
| ----------- | ----------- |
79+
| Gradle Wrapper (Linux/Mac) | ```./gradlew clean build``` |
80+
| Gradle Wrapper (Windows) | ```gradle.bat clean build``` |
81+
| Gradle (command-line) | ```gradle clean build``` |
82+
| Gradle (command-line & setting jvmserver) | ```gradle clean build -Pcics.jvmserver=MYJVM``` |
9183

92-
Run the following in a local command prompt:
84+
### Building with Apache Maven
9385

94-
```shell
95-
mvn clean verify
96-
```
97-
98-
This creates a WAR file inside the `cics-java-liberty-link-app/target` directory and a CICS bundle zIP file inside the `cics-java-liberty-link-bundle/target` directory.
86+
A WAR file is created inside the `cics-java-liberty-link-app/target` directory and a CICS bundle ZIP file inside the `cics-java-liberty-link-bundle/target` directory.
9987

10088
If building a CICS bundle ZIP the CICS JVM server name for the WAR bundle part should be modified in the
101-
`cics.jvmserver` property, defined in [`cics-java-liberty-link-bundle/pom.xml`](cics-java-liberty-link-bundle/pom.xml) file under the `defaultjvmserver` configuration property, or alternatively can be set on the command line as follows.
102-
103-
```shell
104-
mvn clean verify -Dcics.jvmserver=MYJVM
105-
```
89+
`cics.jvmserver` property, defined in [`cics-java-liberty-link-bundle/pom.xml`](cics-java-liberty-link-bundle/pom.xml) file under the `defaultjvmserver` configuration property, or alternatively can be set on the command line.
90+
91+
| Tool | Command |
92+
| ----------- | ----------- |
93+
| Maven Wrapper (Linux/Mac) | ```./mvnw clean verify``` |
94+
| Maven Wrapper (Windows) | ```mvnw.cmd clean verify``` |
95+
| Maven (command-line) | ```mvn clean verify``` |
96+
| Maven (command-line & setting jvmserver) | ```mvn clean verify -Dcics.jvmserver=MYJVM``` |
10697

10798
## Deploying to a Liberty JVM server
10899

0 commit comments

Comments
 (0)