Skip to content

Commit

Permalink
Merge pull request #101 from jamezp/readme-format
Browse files Browse the repository at this point in the history
Use the correct header formats for the README and add a ToC.
  • Loading branch information
jmesnil authored Jul 23, 2024
2 parents 2d3b71d + 90d79e8 commit 20b4684
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions wildfly-getting-started-archetype/README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
WildFly getting started archetype
-----------------------------
= WildFly getting started archetype
:toc:

[[introduction]]
==== Introduction
== Introduction

This archetype creates a new WAR project which contains a simple Restful web
service and a HTML page to call the web service.
Expand All @@ -15,7 +15,7 @@ It is prepared for running Arquillian unit tests.
More details can be found in the file "src/main/resources/archetype-resources/README.txt", which is end-user doc and added to the resulting project.

[[newwildflyversion]]
==== New WildFly version
== New WildFly version
To update this archetype to a new WildFly version:
In file "pom.xml":

Expand All @@ -36,7 +36,7 @@ In file "src/main/resources/archetype-resources/pom.xml":
Also test whether the Arquillian unit test "SampleIT" still works, see below.

[[build]]
==== Build
== Build
To build the archetype, you need at least Java 11. Run this command:
[source,options="nowrap"]
----
Expand All @@ -45,14 +45,14 @@ $ mvn clean install
It will be installed to your local maven repository at "%USERHOME%/.m2/repository/org/wildfly/archetype/wildfly-getting-started-archetype/", and an entry will be added to "%USERHOME%/.m2/repository/archetype-catalog.xml".

[[createproject]]
==== Create project from archetype
== Create project from archetype
To create a new project from this archetype, use this maven command (replace dummy values for "groupId", "artifactId" and "version" with correct values):
----
$ mvn archetype:generate -DgroupId=my.project.org -DartifactId=sampleproject -Dversion=1.0-SNAPSHOT -DarchetypeGroupId=org.wildfly.archetype -DarchetypeArtifactId=wildfly-getting-started-archetype -DarchetypeVersion=28.0.0.Final-SNAPSHOT
----

[[testing]]
==== Test the archetype
== Test the archetype
After having built the archetype, check whether both profiles "arq-remote" and "arq-managed" work. This is done by using scripts found in the directory "testing".

* Profile "arq-managed": set variable JBOSS_HOME, then execute "runtest_managed.bat/.sh <archetypeVersion>" (replace "<archetypeVersion>" with the current archetype version)
Expand Down

0 comments on commit 20b4684

Please sign in to comment.