You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stormcrawler.apache.org by rz...@apache.org on 2024/10/30 06:04:41 UTC
(incubator-stormcrawler) 01/01: Fixes #1301
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch add-build-doc-for-the-source-release-#1301
in repository https://gitbox.apache.org/repos/asf/incubator-stormcrawler.git
commit 87db87698049e81a50f9ae69c069b06eab26f1f9
Author: Richard Zowalla <rz...@apache.org>
AuthorDate: Wed Oct 30 07:04:33 2024 +0100
Fixes #1301
---
README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/README.md b/README.md
index 102cfd33..1cf2345c 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,22 @@ You can enable pre-commit format hooks by running:
mvn clean install -Dskip.format.code=false
```
+### Building from source
+
+The requirements for building from source are as follows
+
+- JDK 11+
+- Apache Maven 3
+- Docker (if you want to run tests)
+
+The build itself is straightforward:
+
+```
+mvn clean install
+```
+
+Note: We use some **binary files** for testing advanced crawler functionality. These files are located exclusively in the `src/test` directories of the respective modules.
+
## Thanks
