@@ -65,3 +65,47 @@ Read our [contribution guide](https://github.com/jMonkeyEngine/jmonkeyengine/blo
65
65
66
66
[ New BSD (3-clause) License] ( https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/LICENSE.md )
67
67
68
+ ### How to Build the Engine from Source
69
+
70
+ 1 . Install a Java Development Kit (JDK),
71
+ if you don't already have one.
72
+ 2 . Point the ` JAVA_HOME ` environment variable to your JDK installation:
73
+ (In other words, set it to the path of a directory/folder
74
+ containing a "bin" that contains a Java executable.
75
+ That path might look something like
76
+ "C:\Program Files\Eclipse Adoptium\jdk-17.0.3.7-hotspot"
77
+ or "/usr/lib/jvm/java-17-openjdk-amd64/" or
78
+ "/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home" .)
79
+ + using Bash or Zsh: ` export JAVA_HOME=" ` * path to installation* ` " `
80
+ + using Fish: ` set -g JAVA_HOME " ` * path to installation* ` " `
81
+ + using Windows Command Prompt: ` set JAVA_HOME=" ` * path to installation* ` " `
82
+ + using PowerShell: ` $env:JAVA_HOME = ' ` * path to installation* ` ' `
83
+ 3 . Download and extract the engine source code from GitHub:
84
+ + using Git:
85
+ + ` git clone https://github.com/jMonkeyEngine/jmonkeyengine.git `
86
+ + ` cd jmonkeyengine `
87
+ + ` git checkout -b latest v3.7.0-stable ` (unless you plan to do development)
88
+ + using a web browser:
89
+ + browse to [ the latest release] ( https://github.com/jMonkeyEngine/jmonkeyengine/releases/latest )
90
+ + follow the "Source code (zip)" link at the bottom of the page
91
+ + save the ZIP file
92
+ + extract the contents of the saved ZIP file
93
+ + ` cd ` to the extracted directory/folder
94
+ 4 . Run the Gradle wrapper:
95
+ + using Bash or Fish or PowerShell or Zsh: ` ./gradlew build `
96
+ + using Windows Command Prompt: ` .\gradlew build `
97
+
98
+ After a successful build,
99
+ fresh JARs will be found in "* /build/libs".
100
+
101
+ You can install the JARs to your local Maven repository:
102
+ + using Bash or Fish or PowerShell or Zsh: ` ./gradlew install `
103
+ + using Windows Command Prompt: ` .\gradlew install `
104
+
105
+ You can run the "jme3-examples" app:
106
+ + using Bash or Fish or PowerShell or Zsh: ` ./gradlew run `
107
+ + using Windows Command Prompt: ` .\gradlew run `
108
+
109
+ You can restore the project to a pristine state:
110
+ + using Bash or Fish or PowerShell or Zsh: ` ./gradlew clean `
111
+ + using Windows Command Prompt: ` .\gradlew clean `
0 commit comments