From 035f75195f34d6e0e6676d1ce0396f998f921a4a Mon Sep 17 00:00:00 2001 From: Arthur Bit-Monnot Date: Fri, 9 Apr 2021 09:11:21 +0200 Subject: [PATCH] Point README to main documentation --- README.md | 48 ++--------------------------------------- doc/src/SUMMARY.md | 3 ++- doc/src/entry-points.md | 5 +++-- doc/src/instances.md | 2 +- doc/src/prelude.md | 4 ++-- 5 files changed, 10 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 2ecade0..53bae15 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,6 @@ -# Heuristic methods for JobShop scheduling +# Heuristic methods for JobShop scheduling (INSA Toulouse 4IR) This repository contains the starter code for the assignment. -## 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 -``` - - -## Documentation - -Documentation for this project is available here : [https://insa-4ir-meta-heuristiques.github.io/doc/](https://insa-4ir-meta-heuristiques.github.io/doc/) +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/) diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md index 3259ad9..5a8f2ed 100644 --- a/doc/src/SUMMARY.md +++ b/doc/src/SUMMARY.md @@ -1,7 +1,8 @@ # Summary - [Welcome](./prelude.md) +- [Entry Points](./entry-points.md) - [Instances](./instances.md) - [Encodings](./encodings.md) - [Solvers](./solvers.md) -- [Entry Points](./entry-points.md) + diff --git a/doc/src/entry-points.md b/doc/src/entry-points.md index 1d8a1b4..3dd5a23 100644 --- a/doc/src/entry-points.md +++ b/doc/src/entry-points.md @@ -51,7 +51,7 @@ AVG - - 1.0 - 9.1 Fields in the result view are the following : - `instance`: name of the instance - `size`: size of the instance `{num-jobs}x{num-tasks}` -- `best`: best known resultfor this instance +- `best`: best known result for this instance - `runtime`: time taken by the solver in milliseconds (rounded) - `makespan`: makespan of the solution - `ecart`: normalized distance to the best result: `100 * (makespan - best) / best` @@ -71,4 +71,5 @@ AVG - - 0.3 - 31.5 999.0 - 20.4 Here the last line give the average `runtime` and `ecart` for each solver. -**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. \ No newline at end of file +**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. +For instance running the program with the option `--instance la` will select all Lawrences instance (`la01` to `la40`). \ No newline at end of file diff --git a/doc/src/instances.md b/doc/src/instances.md index 3f0682d..a2b3bd8 100644 --- a/doc/src/instances.md +++ b/doc/src/instances.md @@ -12,7 +12,7 @@ We provide three of them - `aaa1`: a very small instance that you can use to get acquainted with the different encodings - `aaa2`: a slightly more complex instance that has been used during the classes - - `aaa3`: a instance that produces deterministic results for the greedy methods + - `aaa3`: an instance that produces deterministic results for the greedy methods ## Benchmark instances diff --git a/doc/src/prelude.md b/doc/src/prelude.md index 9930538..f382872 100644 --- a/doc/src/prelude.md +++ b/doc/src/prelude.md @@ -24,8 +24,8 @@ To import the project in IntelliJ (once IntelliJ is running): 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. + - Right click on the `src/main/java/jobshop/Main` class in the project view. + - Select `Run Main.main()`. The program should execute but 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)