summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2020-01-12 15:42:02 +0100
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2020-01-12 15:42:02 +0100
commit4c5847bffd0401e62a3f2beaeba8c0cb887359ce (patch)
tree127d56260008d7cb2f243c6b2e61010cc301bdd5 /README.md
parente00c80770d867a49979eb86724cd6c94f7a8d2e2 (diff)
Import fresh Quarkus project.
Change-Id: I05fa5dd499cdca04adee9afbef9f83b3afd8fe0f
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1cb0c25
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# mulkcms2 project
+
+This project uses Quarkus, the Supersonic Subatomic Java Framework.
+
+If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
+
+## Running the application in dev mode
+
+You can run your application in dev mode that enables live coding using:
+```
+./gradlew quarkusDev
+```
+
+## Packaging and running the application
+
+The application is packageable using `./gradlew quarkusBuild`.
+It produces the executable `mulkcms2-1.0.0-SNAPSHOT-runner.jar` file in `build` directory.
+Be aware that it’s not an _über-jar_ as the dependencies are copied into the `build/lib` directory.
+
+The application is now runnable using `java -jar build/mulkcms2-1.0.0-SNAPSHOT-runner.jar`.
+
+If you want to build an _über-jar_, just add the `--uber-jar` option to the command line:
+```
+./gradlew quarkusBuild --uber-jar
+```
+
+## Creating a native executable
+
+You can create a native executable using: `./gradlew buildNative`.
+
+Or you can use Docker to build the native executable using: `./gradlew buildNative --docker-build=true`.
+
+You can then execute your binary: `./build/mulkcms2-1.0.0-SNAPSHOT-runner`
+
+If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling#building-a-native-executable . \ No newline at end of file