updated README.md

README.md

@@ -1,5 +1,22 @@
+<img src="icon.png" height="200">
+
 # Heuristic methods for JobShop scheduling (INSA Toulouse 4IR)
+## Group
+- Lejeune Aurélia 
+- Lacroix Raphaël
 
-This repository contains the starter code for the assignment.
+## Description
+This is the repository for our 4th year project of Heuristics class.
+This project covers algorithms aiming at solving jobshop problems, including greedy algorithms, descent algorithms, and tabu algorithms.
 
-To get started with the project, please follow the documentation: [https://insa-4ir-meta-heuristiques.github.io/jobshop/](https://insa-4ir-meta-heuristiques.github.io/jobshop/)
+**The [full report](Rapport_Metaheuristique_Aurelia_LEJEUNE_Raphael_LACROIX.pdf) for this assigment**
+
+## Documentation
+The basic documentation is at : [https://insa-4ir-meta-heuristiques.github.io/jobshop/](https://insa-4ir-meta-heuristiques.github.io/jobshop/)
+However we implemented additional features for testing purposes that were outside the scope of the practical :
+
+When running an algorithm affected by randomness (please take a look at the [report](Rapport_Metaheuristique_Aurelia_LEJEUNE_Raphael_LACROIX.pdf) for this assigment** for more information):
+- Using `-r` or `--random` enables to specify a randomness value (between `0` and `100`, `default` being `0`)
+- Using `-rn` or `--randomRunNumber` enables to specify a number of runs before picking the best one (positive number, `default` being `10`).
+- Cycle detection in the Tabu can be turned off by commenting the `break` instruction line _103_
+- Graph printing in the Tabu can be turned off by commenting the `new SwingWrapper(chart).displayChart();` instruction line _145_