Skip to content

Commit

Permalink
Clarify Using vs. Building
Browse files Browse the repository at this point in the history
Link to appropriate sections from website on how to use ACS AEM Commons
  • Loading branch information
kwin committed Nov 21, 2024
1 parent ce0a11c commit 213279b
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -21,26 +35,20 @@ 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

vlt --credentials admin:admin checkout -f ../META-INF/vault/filter.xml --force http://localhost:4502/crx

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 <goals>

## 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
Expand Down

0 comments on commit 213279b

Please sign in to comment.