diff --git a/doc/src/prelude.md b/doc/src/prelude.md index f82f58e..9930538 100644 --- a/doc/src/prelude.md +++ b/doc/src/prelude.md @@ -1 +1,54 @@ # Welcome + +In this page, we briefly discuss setting up a productive environment for the assignment. The following pages provide an high-level view of the architecture and main components of the provided source code. + +## Setting up + + +You should start by cloning the repository containing the source code. + +``` +git clone https://github.com/insa-4ir-meta-heuristiques/template-jobshop +``` + +### Working in IntelliJ + +For working on this project, we recommend using the IntelliJ-IDEA development environment. It is available in INSA's +classrooms as well as on `montp.insa-toulouse.fr`. + +To import the project in IntelliJ (once IntelliJ is running): + + - Open a new project : `Open project` or `File > Open` + - Select the `gradle.build` file in the cloned repository. + - Select `Open as project`. + +To run the program in IntelliJ, you can + + - Right click on the `src/main/java/Jobshop/Main` class in the project view. + - Select `Run Main.main()`. It should complain that some arguments are missing. + - Give it the expected command line arguments : `Run > Edit Configuration`, then fill in the `Program arguments` text box. + +### Working on the command line (Gradle) + +Compilation instructions are given for Linux. On Windows you can use the `gradlew.bat` script (but you are on your own). + +``` +❯ ./gradlew build # Compiles the project +``` + +The project can be executed directly with `gradle` by specifying the arguments like so : + +``` +❯ ./gradlew run --args="--solver basic random --instance aaa1 ft" +``` + +You can also build an executable jar file, and run it with the java command. +This is especially useful if you want to run it on another machine. + +``` + # Create a jar file with all dependencies in build/libs/JSP.jar +❯ ./gradlew jar +# Run the jar file. Only requires a Java Runtime Environment (JRE) +❯ java -jar build/libs/JSP.jar --solver basic --instance ft06 +``` + diff --git a/doc/src/solvers.md b/doc/src/solvers.md index 425967f..4a5437d 100644 --- a/doc/src/solvers.md +++ b/doc/src/solvers.md @@ -21,7 +21,7 @@ It repeats this process until the deadline to produce a result is met and finall ## Greedy solver -The greddy solver is not implemented yet. +The greedy solver is not implemented yet. Its constructor accepts a parameter that specifies the priority that should be used to produce solutions. ## Descent Solver