Below is the unedited project readme file, as originally supplied with the assignment. Do note that this project also included writing an implementation Wiki.
Reference implementation and framework for the concurrent programming project 2020.
This project is structured as follows:
src/main/java/com/pseuco/np20/
: Java source code of the project.model/
: Data structures for the simulation.simulation/rocket/
: Your implementation goes here.simulation/common/
: Simulation functionality you might find useful.simulation/slug/
: The sequential reference implementation.validator/
: The validator interface.Simulation.java
: Implements themain
method.
src/test
: Public tests for the project.scenarios
: Some example scenarios.
We use Gradle to build the project.
To build the Javadoc run:
./gradlew javaDoc
Afterwards you find the documentation in build/docs
.
To build a simulation.jar
-File for your project run:
./gradlew jar
You find the compiled .jar
-File in out
.
To run the public tests on your project run:
./gradlew test
We recommend you use a proper Integrated Development Environment (IDE) for this project. A good choice you should already be familiar with from Programming 2 is Eclipse. Another good open source IDE is VS Code. While Eclipse is more focused on Java and provides a better experience when it comes to Java programming, VS Code is more universal and might be worth using as a general editor during your studies for all kinds of tasks like writing your bachelor thesis. Which IDE or editor you use is up to you. However, we only provide help for Eclipse and VS Code. In case you use something else, do not expect help.
In case you decide to use VS Code, we recommend installing the Java Extension Pack and the Gradle Extension Pack.