diff --git a/README.md b/README.md index 1e7f64c13e2e02a35a5507f2f6491dd62c3b4bc2..8bef7da8f232fd261c12d4ca8412ad127489c12b 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ Julia module for the Symmetric Travelling Salesman Problem using the Held and Ka Our project is presented in the from of a Julia Jupyter notebook. -# Requirements - # Viewing the project ## General presentation of notebooks @@ -39,3 +37,20 @@ If you just want to see/run the code without the printing and block structure, y ``` jupyter nbconvert --to script heldAndKarp.ipynb ``` + + +# Requirements for running the code + +If you want to run the code, either as a notebook or a script, the following libraries are necessary : + +* Cbc v0.7.1 +* Combinatorics v1.0.2 +* GraphPlot v0.4.4 +* JuMP v0.21.4 +* LightGraphs v1.3.5 + +Details about package installation in Julia can be found (here)[https://docs.julialang.org/en/v1/stdlib/Pkg/]. The gist of it is : +* type `julia` in a shell terminal +* press `]` +* type `add PackageName` (PackageName can be Cbc for instance) +