Browse Source

Point README to main documentation

Arthur Bit-Monnot 3 months ago
parent
commit
035f75195f
5 changed files with 10 additions and 52 deletions
  1. 2
    46
      README.md
  2. 2
    1
      doc/src/SUMMARY.md
  3. 3
    2
      doc/src/entry-points.md
  4. 1
    1
      doc/src/instances.md
  5. 2
    2
      doc/src/prelude.md

+ 2
- 46
README.md View File

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

+ 2
- 1
doc/src/SUMMARY.md View File

@@ -1,7 +1,8 @@
1 1
 # Summary
2 2
 
3 3
 - [Welcome](./prelude.md)
4
+- [Entry Points](./entry-points.md)
4 5
 - [Instances](./instances.md)
5 6
 - [Encodings](./encodings.md)
6 7
 - [Solvers](./solvers.md)
7
-- [Entry Points](./entry-points.md)
8
+

+ 3
- 2
doc/src/entry-points.md View File

@@ -51,7 +51,7 @@ AVG      -        -          1.0        -   9.1
51 51
 Fields in the result view are the following :
52 52
 - `instance`: name of the instance
53 53
 - `size`: size of the instance `{num-jobs}x{num-tasks}`
54
-- `best`: best known resultfor this instance
54
+- `best`: best known result for this instance
55 55
 - `runtime`: time taken by the solver in milliseconds (rounded)
56 56
 - `makespan`: makespan of the solution
57 57
 - `ecart`: normalized distance to the best result: `100 * (makespan - best) / best` 
@@ -71,4 +71,5 @@ AVG      -        -          0.3        -  31.5          999.0        -  20.4
71 71
 Here the last line give the average `runtime` and `ecart` for each solver.
72 72
 
73 73
 
74
-**Tip:** When selecting instance to solve, you can only provide a prefix to instance name. All instances that start with this prefix will be selected.
74
+**Tip:** When selecting instances to solve, you can only provide a prefix to instance name. All instances that start with this prefix will be selected.
75
+For instance running the program with the option `--instance la` will select all Lawrences instance (`la01` to `la40`).

+ 1
- 1
doc/src/instances.md View File

@@ -12,7 +12,7 @@ We provide three of them
12 12
 
13 13
  - `aaa1`: a very small instance that you can use to get acquainted with the different encodings
14 14
  - `aaa2`: a slightly more complex instance that has been used during the classes
15
- - `aaa3`: a instance that produces deterministic results for the greedy methods
15
+ - `aaa3`: an instance that produces deterministic results for the greedy methods
16 16
 
17 17
 
18 18
 ## Benchmark instances

+ 2
- 2
doc/src/prelude.md View File

@@ -24,8 +24,8 @@ To import the project in IntelliJ (once IntelliJ is running):
24 24
 
25 25
 To run the program in IntelliJ, you can 
26 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.
27
+ - Right click on the `src/main/java/jobshop/Main` class in the project view.
28
+ - Select `Run Main.main()`. The program should execute but complain that some arguments are missing.
29 29
  - Give it the expected command line arguments : `Run > Edit Configuration`, then fill in the `Program arguments` text box.
30 30
 
31 31
 ### Working on the command line (Gradle)

Loading…
Cancel
Save