From: Alexander Kriegisch <Alexander@Kriegisch.name>
Date: Thu, 28 Mar 2024 10:26:34 +0000 (+0100)
Subject: README.md: Add hint about project root folder name requirement
X-Git-Tag: V1_9_22_1~35
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c4e2049086b9074ef9272454e77e341288e8caf2;p=aspectj.git

README.md: Add hint about project root folder name requirement

Closes #299.

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
---

diff --git a/README.md b/README.md
index 3b3b06042..001127e57 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,9 @@ In the root of a cloned AspectJ simply run:
 ./mvnw clean install
 ```
 
+Please make sure that your project root directory name is either _aspectj_ (default for `git clone`) or _org.aspectj_ (case-insensitive), if you wish to run the build with tests.
+Some integration tests rely on this name when dynamically searching the up current path for the root folder.
+
 You can also use a reasonably recent (3.6.3+), locally installed Maven installation instead of the Maven wrapper script.
 
 This will build all the modules, run all the tests and install the key artifacts in your local repository.