From 213279b88757a3798893397f09ec74e39f16a1b3 Mon Sep 17 00:00:00 2001 From: Konrad Windszus Date: Sat, 9 Nov 2024 11:05:38 +0100 Subject: [PATCH] Clarify Using vs. Building Link to appropriate sections from website on how to use ACS AEM Commons --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9e3849f111..0b3eeaba1a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,20 @@ This project is a unified collection of AEM/CQ code generated by the AEM consulting practice. +## Using + +Please refer to [Add ACS AEM Commons to your AEM Maven project](https://adobe-consulting-services.github.io/acs-aem-commons/pages/maven.html) for how to install its package and use its API. + +### Prerequisites + +The prerequisites are listed in [Compatibility](https://adobe-consulting-services.github.io/acs-aem-commons/pages/compatibility.html). + +### Distribution + ++ Maven artifact available from Maven central: [https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all](https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all) ++ Github releases: [https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases](https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases) + + ## Building This project uses Maven for building. Common commands: @@ -21,7 +35,7 @@ The Maven profile `cloud` is used to both build both the AEMaaCS and the AEM 6.5 To build only the version for AEM 6.5 (without using any other profiles) use the command line option `-P \!cloud` [to deactivate the default profile `cloud`](https://maven.apache.org/guides/introduction/introduction-to-profiles.html#deactivating-a-profile). -## Using with VLT +### Deploying with VLT To use vlt with this project, first build and install the package to your local AEM instance as described above. Then cd to `content/src/main/content/jcr_root` and run @@ -29,18 +43,12 @@ To use vlt with this project, first build and install the package to your local Once the working copy is created, you can use the normal ``vlt up`` and ``vlt ci`` commands. -## Specifying AEM Host/Port +### Specifying AEM Host/Port The AEM host and port can be specified on the command line with: mvn -Dcrx.host=otherhost -Dcrx.port=5502 -## Distribution - -+ Maven artifact available from Maven central: [https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all](https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all) -+ Github releases: [https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases](https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases) - - -## Rules +### Rules * Spaces, not tabs. * Provide documentation in the parent org GH project: https://github.com/Adobe-Consulting-Services/adobe-consulting-services.github.io