summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f133a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Eclipse Starter for Jakarta EE
+This is a sample application generated by the Eclipse Foundation starter for Jakarta EE.
+
+* You can build the application by executing the following command from the directory where this file resides. Please ensure you have installed a [Java SE 8+ implementation](https://adoptium.net/?variant=openjdk8) appropriate for your Jakarta EE version (we have tested with Java SE 8, Java SE 11 and Java SE 17). Note, the [Maven Wrapper](https://maven.apache.org/wrapper/) is already included in the project, so a Maven install is not actually needed. You may first need to execute `chmod +x mvnw`.
+
+ ```
+ ./mvnw clean package
+ ```
+
+ This will generate a file named `jakartaee-hello-world.war`. You should be able to run the application by deploying the file to
+ a [Jakarta EE compatible runtime](https://jakarta.ee/compatibility).