You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by an...@apache.org on 2019/05/02 18:15:44 UTC
[sling-project-archetype] branch master updated: Added instructions
to the Readme file about the regular usage
This is an automated email from the ASF dual-hosted git repository.
andysch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-project-archetype.git
The following commit(s) were added to refs/heads/master by this push:
new ea9cf68 Added instructions to the Readme file about the regular usage
ea9cf68 is described below
commit ea9cf68e24dcb523826fbcc69aef2cf7de68efbc
Author: Andreas Schaefer <ac...@Andreass-iMac.local>
AuthorDate: Thu May 2 11:15:30 2019 -0700
Added instructions to the Readme file about the regular usage
---
README.md | 28 +++++++++++++++++++---------
1 file changed, 19 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index e17377f..ea77fbd 100644
--- a/README.md
+++ b/README.md
@@ -52,17 +52,27 @@ how to build and deploy the entire project in one step.
#### Usage
-Until this project is fully released in the public Maven Repo this is how to use it:
-
-* Build this project locally
-
- mvn clean install
-
+You can create a project with this archetype using this command:
+```
+mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.sling \
+ -DarchetypeArtifactId=sling-project-archetype \
+ -DarchetypeVersion=1.0.0
+```
+Maven will then guide you through the configuration process to fill in all the
+properties and then create the project.
+
+#### Local Build and Usage
+
+* Build this project locally with
+```
+mvn clean install
+```
* Go to your folder where you want your generated project to be
* Generate it with:
-
- mvn archetype:generate -DarchetypeCatalog=local
-
+```
+mvn archetype:generate -DarchetypeCatalog=local
+```
* Select this Archetype from a given list
* Provide the requested properties