summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Andreas Benkard <code@mail.matthias.benkard.de>2020-04-18 08:14:16 +0200
committerMatthias Andreas Benkard <code@mail.matthias.benkard.de>2020-04-18 08:14:16 +0200
commit8c5047cf7f6a7a13d48db9d4d6d0f7584b0a6cab (patch)
treeb2eb6e094fdd2eed5dfb832b45cd8bdc600cb75a
parent5e5e70afe081cf6a11b74148b6c02c6f272495e4 (diff)
Replace the autogenerated README.md with a new README.adoc.
Change-Id: I8799855bd21e3b6fc2a28b4b42ba0e5a6134bdbb
-rw-r--r--README.adoc59
-rw-r--r--README.md35
2 files changed, 59 insertions, 35 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..b885736
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,59 @@
+= MulkCMS 2
+Matthias Andreas Benkard
+// Meta
+:experimental:
+:data-uri:
+:sectnums:
+:toc:
+:stem:
+:toclevels: 2
+:description: MulkCMS Manual
+:keywords: mulk
+// Settings
+:icons: font
+:source-highlighter: pygments
+
+== Resources
+
+|===
+|Resource |Links
+
+|Public Deployment
+|https://matthias.benkard.de/[mt.benkard.de]
+
+|Bug Tracker
+|MantisBT
+
+|Work Board
+|Kanboard: https://kanboard.benkard.de/board/4[private],
+ https://kanboard.benkard.de/public/board/4cb836c795ae131c33613d6d6fcbcc9f0a10ab30ad7b4bb1f0e7b847d5cf[public read-only]
+
+|Docker image
+|https://docker.benkard.de/repositories/10[Portus]
+|===
+
+
+== Running
+
+To run the application with live reloading enabled:
+
+[source]
+----
+./mvnw quarkus:dev
+----
+
+== Packaging
+
+Do build JARs and a JVM-based Docker image and push the Docker image to https://docker.benkard.de/repositories/10[Portus]:
+
+[source]
+----
+./mvnw package
+----
+
+To build a native image with https://graalvm.org[GraalVM] instead:
+
+[source]
+----
+./mvnw package -Pnative
+----
diff --git a/README.md b/README.md
deleted file mode 100644
index 1cb0c25..0000000
--- a/README.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# 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