Skip to content

Commit 44f5672

Browse files
committed
Update README.md
1 parent e047ff9 commit 44f5672

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,32 @@ This project provides Java bindings for [Box2D](https://box2d.org/) using the J
33

44
# Supported Platforms
55
Windows and Linux are directly supported. The Linux .so file was built on Linux Mint 22.2.
6-
Nevertheless, you can use these bindings for Mac if you provide your own .dylib file and load it.
6+
7+
Nevertheless, you should be able to use these bindings for Mac if you provide your own `.dylib` file and load it.
8+
9+
# Building The Project
10+
1. Download [Java 26](https://www.oracle.com/de/java/technologies/downloads/)
11+
2. Download the sources or clone the repo
12+
13+
## Using The Terminal
14+
15+
3. Install [Maven](https://maven.apache.org/download.cgi)
16+
4. Open the terminal in the directory of the downloaded project
17+
5. Run the goal `mvn package`.
18+
6. The output is in the `target/` folder
19+
20+
## Using An IDE
21+
22+
3. Import the project in an IDE of your choice as a maven project
23+
- [IntelliJ](https://www.jetbrains.com/guide/java/tutorials/working-with-maven/importing-a-project/)
24+
- [Eclipse](https://www.lagomframework.com/documentation/1.6.x/java/EclipseMavenInt.html)
25+
4. Create a new maven run configuration and add the goal `mvn package`
26+
- [IntelliJ](https://www.jetbrains.com/help/idea/run-debug-configuration-maven.html)
27+
- [Eclipse](https://www.genuitec.com/docs/assembly/setting-up-maven-launch-configurations/)
28+
5. Run the created configuration
29+
6. The output is also in the `target/` folder
30+
31+
If you are using the Eclipse IDE, you do not need to build the project explicitly. You can import this project into a workspace and just add the Maven coordinates into the `pom.xml` file of any other Maven project in the same workspace. This works as Eclipse can resolve Maven dependencies directly from the workspace, without requiring the project to be installed into the local Maven repository.
732

833
# Usage
934
This project requires Java 26 and preview features enabled.

0 commit comments

Comments
 (0)