You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/01/12 17:49:24 UTC

[maven-build-cache-extension] branch master updated: improve build instructions

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-build-cache-extension.git


The following commit(s) were added to refs/heads/master by this push:
     new 36aded0  improve build instructions
36aded0 is described below

commit 36aded0ebc06bc086203bded72e11f624bb017b9
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Wed Jan 12 18:49:21 2022 +0100

    improve build instructions
---
 README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 9d83181..c650a9c 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,15 @@ Read [cache guide](src/site/markdown/cache.md) for more details.
 
 Building
 --------
-The code currently relies on un-released modifications in the core Maven project.  Two submodules are included in this git repository to allow building the needed distributions and perform integration tests using those.
+The code currently relies on un-released modifications in the core Maven project.  Two [gitmodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) are included in this git repository to allow building the needed Maven distributions and perform integration tests using those: run `git submodule init && git submodule update` to prepare content.
 
-In order to build those distributions, you first need to launch once the `build-maven.sh` script or the following command in the `maven/maven3` and `maven/maven4` directories:
+In order to build those Maven distributions, you first need to launch once the `build-maven.sh` script or the following command in the `maven/maven3` and `maven/maven4` directories:
 ```
 mvn install -DskipTests -P versionlessMavenDist
 ```
-This will build the custom distributions of maven.
+This will build the custom distributions of Maven.
+
+Then you can build the extension like a normal Maven project.
 
 License
 -------