diff --git a/README.md b/README.md index b808204d..c0f8e53b 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Please refer to the license for details. ## Getting Started ## - +First, read the installation [instructions](INSTALL). The package `org.jorlib.demo` includes small demo applications to help you get started. If you spawn your own demo app and think others can benefit from it, please send it to us and we will add it to that package.

Running examples directly from the demo package is easy. Try for example: - "java -cp jorlib-demo--uber.jar org.jorlib.demo.alg.tsp.separation.SubtourSeparatorDemo" to run the SubtourSeparatorDemo @@ -32,7 +32,7 @@ or - "java -Djava.library.path=/opt/ILOG/CPLEX_Studio1261/cplex/bin/x86-64_linux/ -cp jorlib-demo--uber.jar org.jorlib.demo.frameworks.columnGeneration.bapExample.TSPSolver" to run the Branch-and-Price example. Obviously, you need to ensure that java.library.path points to your own Cplex installation. ## Documentation ## -Javadoc for the latest version can be found [here](http://coin-or.github.io/jorlib/apidocs/); documentation per version is bundled with every release. Releases can be found on our [release page](https://github.com/coin-or/jorlib/releases). There is also a [manual](http://coin-or.github.io/jorlib/manual/manual.pdf) with an in-depth discussion on the Column Generation and Branch-and-Price features of the library. +Installation istructions are available [here](INSTALL); Javadoc for the latest version can be found [here](http://coin-or.github.io/jorlib/apidocs/); documentation per version is bundled with every release. Releases can be found on our [release page](https://github.com/coin-or/jorlib/releases). There is also a [manual](http://coin-or.github.io/jorlib/manual/manual.pdf) with an in-depth discussion on the Column Generation and Branch-and-Price features of the library. ## Dependencies ##