From cb5b257277d4d0379714a55d0e05569c5647fbcd Mon Sep 17 00:00:00 2001
From: Martin Goik <goik@hdm-stuttgart.de>
Date: Sun, 12 Nov 2023 09:37:02 +0100
Subject: [PATCH] Enhanced documentation
---
.../mi-maven-archetype-javafxml/README.md | 38 ++++++++++---------
1 file changed, 21 insertions(+), 17 deletions(-)
diff --git a/ws/Archetypes/mi-maven-archetype-javafxml/README.md b/ws/Archetypes/mi-maven-archetype-javafxml/README.md
index f2a981581..dba5ed585 100644
--- a/ws/Archetypes/mi-maven-archetype-javafxml/README.md
+++ b/ws/Archetypes/mi-maven-archetype-javafxml/README.md
@@ -1,29 +1,33 @@
-# Modified Maven archetype
+# Modified JavaFXML Maven archetype
This archetype has been derived from https://github.com/openjfx/javafx-maven-archetypes /
-https://mvnrepository.com/artifact/org.openjfx/javafx-archetype-fxml demonstrating JavaFX application assembly.
-There is added java FXML https://docs.oracle.com/javafx/2/get_started/fxml_tutorial.htm support including both the Log4j
-and Junit framework.
+https://mvnrepository.com/artifact/org.openjfx/javafx-archetype-fxml. The following features have been added:
+
+- FXML support https://docs.oracle.com/javafx/2/get_started/fxml_tutorial.htm
+- current Log4j and Junit.
## Hosting
-This archetype is being hosted at
-https://maven.mi.hdm-stuttgart.de/nexus/#browse/browse:mi-maven:de%2Fhdm_stuttgart%2Fmi%2Fmi-maven-archetype-javafxml .
+The archetype is available from
+https://maven.mi.hdm-stuttgart.de/nexus/#browse/browse:mi-maven:de%2Fhdm_stuttgart%2Fmi%2Fmi-maven-archetype-javafxml.
## Getting started
+<!-- language-all: bash -->
1. Follow https://freedocs.mi.hdm-stuttgart.de/sd1_sect_mavenCli.html#sd1_fig_mavenMiRepo to configure the above MI
- Maven Nexus Maven repository server.
-2. Create a project by executing:
-```bash
-mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=de.hdm-stuttgart.mi \
- -DarchetypeArtifactId=mi-maven-archetype-javafxml -DarchetypeVersion=21.0.1 \
- -DgroupId=de.mi.hdm_stuttgart -DartifactId=hellojavafx -DinteractiveMode=false
-```
-3. Execute `mvn javafx:run`. You should see a GUI window popping up. Enter input and see corresponding log entries
- in your underlying shell-
+ Maven Nexus Maven repository server for CLI usage.
+2. Choose your desired archetype version and create a new project by executing:
+
+ mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=de.hdm-stuttgart.mi \
+ -DarchetypeArtifactId=mi-maven-archetype-javafxml -DarchetypeVersion=21.0.1 \
+ -DgroupId=de.mi.hdm_stuttgart -DartifactId=hellojavafx -DinteractiveMode=false
+
+4. Execute `mvn javafx:run`. You should see a GUI window popping up. Enter input and see corresponding log entries
+ in your underlying shell. In case you favour the Idea GUI over terminal commands you may click
+ `Run -->Edit Configurations`. Then add a Maven run configuration entering `javafx:run` in the Run / Command line
+ textfield mimicking the previous `mvn javafx:run` terminal command.
4. Optional: Working with IntelliJ IDEA follow
https://freedocs.mi.hdm-stuttgart.de/sd1_sect_idea.html#sd1_fig_mavenIdeaArchetypeCatalogPlugin to configure
- the MI Maven Nexus Maven repository server in your IDE as well. You may add a `javafx:run` to your project's
- run configurations.
+ the MI Maven Nexus Maven repository server in your IDE as well. This allows for using the current archetype for
+ creating new JavaFXML projects by virtue of Idea's GUI.
--
GitLab