From c7f3b4f7e42784a0bcded517bde5c287f5115d1b Mon Sep 17 00:00:00 2001 From: Manas Marthi Date: Thu, 1 May 2025 18:54:33 +0530 Subject: [PATCH] Update CONTRIBUTING.md Added notes about JDK 17 and `gu` command's availability --- CONTRIBUTING.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ab4517a0..3d9938f23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,7 +110,25 @@ This projects is composed of several main modules/components: ### Build the Java part -Building the java part is as simple as: + +**Pre requisite**: Building this requires **GraalVM JDK version 17** and the **Javascript Engine**. +GraalVM website does not give link to install this. Use the command `sdk install java 17.0.9-graalce` to install GraalVM JDK 17. + +Javascript engine needs to be installed using `gu` command. + +**Note**: `gu` commnd is removed from the GraalVM distribution from version 19 and upwards. So you can't build this with latest JDK. + +**On Linux or Mac:** +``` +$JAVA_HOME/bin/gu install js +``` +**On windows:** + +``` +%JAVA_HOME%/bin/gu install js +``` + +#### Compilation step ```bash mvn -Pcodegen install