|
@@ -1 +1,54 @@
|
1
|
1
|
# Welcome
|
|
2
|
+
|
|
3
|
+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.
|
|
4
|
+
|
|
5
|
+## Setting up
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+You should start by cloning the repository containing the source code.
|
|
9
|
+
|
|
10
|
+```
|
|
11
|
+git clone https://github.com/insa-4ir-meta-heuristiques/template-jobshop
|
|
12
|
+```
|
|
13
|
+
|
|
14
|
+### Working in IntelliJ
|
|
15
|
+
|
|
16
|
+For working on this project, we recommend using the IntelliJ-IDEA development environment. It is available in INSA's
|
|
17
|
+classrooms as well as on `montp.insa-toulouse.fr`.
|
|
18
|
+
|
|
19
|
+To import the project in IntelliJ (once IntelliJ is running):
|
|
20
|
+
|
|
21
|
+ - Open a new project : `Open project` or `File > Open`
|
|
22
|
+ - Select the `gradle.build` file in the cloned repository.
|
|
23
|
+ - Select `Open as project`.
|
|
24
|
+
|
|
25
|
+To run the program in IntelliJ, you can
|
|
26
|
+
|
|
27
|
+ - Right click on the `src/main/java/Jobshop/Main` class in the project view.
|
|
28
|
+ - Select `Run Main.main()`. It should complain that some arguments are missing.
|
|
29
|
+ - Give it the expected command line arguments : `Run > Edit Configuration`, then fill in the `Program arguments` text box.
|
|
30
|
+
|
|
31
|
+### Working on the command line (Gradle)
|
|
32
|
+
|
|
33
|
+Compilation instructions are given for Linux. On Windows you can use the `gradlew.bat` script (but you are on your own).
|
|
34
|
+
|
|
35
|
+```
|
|
36
|
+❯ ./gradlew build # Compiles the project
|
|
37
|
+```
|
|
38
|
+
|
|
39
|
+The project can be executed directly with `gradle` by specifying the arguments like so :
|
|
40
|
+
|
|
41
|
+```
|
|
42
|
+❯ ./gradlew run --args="--solver basic random --instance aaa1 ft"
|
|
43
|
+```
|
|
44
|
+
|
|
45
|
+You can also build an executable jar file, and run it with the java command.
|
|
46
|
+This is especially useful if you want to run it on another machine.
|
|
47
|
+
|
|
48
|
+```
|
|
49
|
+ # Create a jar file with all dependencies in build/libs/JSP.jar
|
|
50
|
+❯ ./gradlew jar
|
|
51
|
+# Run the jar file. Only requires a Java Runtime Environment (JRE)
|
|
52
|
+❯ java -jar build/libs/JSP.jar --solver basic --instance ft06
|
|
53
|
+```
|
|
54
|
+
|