Skip to content

Commit 9184df1

Browse files
committed
readme build section update
1 parent 798b073 commit 9184df1

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -50,38 +50,37 @@ a CICS bundle project.
5050
1. Ensure the web project is targeted to compile at a level that is compatible with the Java level being used on CICS. This can be achieved by editing the Java Project Facet in the project properties.
5151
1. Create a CICS bundle project called `com.ibm.cicsdev.restapp.cicsbundle` and add a dynamic web project include for the project created in step 1.
5252

53-
### Building the Example
53+
## Building the Sample
5454

55-
The sample can be built using the supplied Gradle or Maven build files to produce a WAR file and optionally a CICS Bundle archive.
55+
The sample can be built using Gradle or Maven to produce a WAR file and optionally a CICS Bundle archive.
5656

57-
#### Gradle (command line)
57+
### Building with Gradle
5858

59-
Run the following in a local command prompt:
59+
A WAR file is created inside the `build/libs` directory and a CICS bundle ZIP file inside the `build/distributions` directory.
6060

61-
`gradle clean build`
61+
If using the CICS bundle ZIP, the CICS JVM server name should be modified in the `cics.jvmserver` property in the gradle build [file](build.gradle) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line.
6262

63-
This creates a WAR file inside the `build/libs` directory and a CICS bundle ZIP file inside the `build/distributions` directory.
63+
| Tool | Command |
64+
| ----------- | ----------- |
65+
| Gradle Wrapper (Linux/Mac) | ```./gradlew clean build``` |
66+
| Gradle Wrapper (Windows) | ```gradle.bat clean build``` |
67+
| Gradle (command-line) | ```gradle clean build``` |
68+
| Gradle (command-line & setting jvmserver) | ```gradle clean build -Pcics.jvmserver=MYJVM``` |
6469

65-
If using the CICS bundle ZIP, the CICS JVM server name should be modified in the `cics.jvmserver` property in the gradle build [file](build.gradle) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line as follows.
6670

71+
### Building with Apache Maven
72+
A WAR file and a CICS bundle ZIP file are created inside the `target/` directory.
6773

68-
`gradle clean build -Pcics.jvmserver=MYJVM`
69-
70-
71-
#### Maven (command line)
72-
73-
Run the following in a local command prompt which will create a WAR file for deployment.
74-
75-
`mvn clean verify`
76-
77-
This creates a WAR file in the `target` directory.
78-
79-
If building a CICS bundle ZIP the CICS bundle plugin bundle-war goal is driven using the maven verify phase. The CICS JVM server name should be modified in the `<cics.jvmserver>` property in the [`pom.xml`](pom.xml) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line as follows.
80-
81-
`mvn clean verify -Dcics.jvmserver=MYJVM`
82-
74+
If building a CICS bundle ZIP the CICS bundle plugin bundle-war goal is driven using the maven verify phase. The CICS JVM server name should be modified in the `<cics.jvmserver>` property in the [`pom.xml`](pom.xml) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line.
8375

76+
Tool | Command |
77+
| ----------- | ----------- |
78+
| Maven Wrapper (Linux/Mac) | ```./mvnw clean verify``` |
79+
| Maven Wrapper (Windows) | ```mvnw.cmd clean verify``` |
80+
| Maven (command-line) | ```mvn clean verify``` |
81+
| Maven (command-line & setting jvmserver) | ```mvn clean verify -Dcics.jvmserver=MYJVM``` |
8482

83+
## Deployment
8584
### To start a JVM server in CICS:
8685
1. Enable Java support in the CICS region by adding the `SDFJAUTH` library to the `STEPLIB` concatenation and setting `USSHOME` and the `JVMPROFILEDIR` SIT parameters.
8786
* This step is **not** required if using CICS 5.5 or later
@@ -101,9 +100,9 @@ If building a CICS bundle ZIP the CICS bundle plugin bundle-war goal is driven u
101100
**Note:** A sample DFHCSDUP input file for the required CICS BUNDLE resource definition is supplied in the supporting file [DFHCSD.txt](etc/DFHCSD.txt) file.
102101

103102

104-
### Running the Example
103+
## Running the Sample
105104

106-
#### Using a web browser you can issue the following HTTP GET requests
105+
### Using a web browser you can issue the following HTTP GET requests
107106

108107
* http://host:port/com.ibm.cicsdev.restapp/rest/cicsinfo
109108

0 commit comments

Comments
 (0)