summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorharpreet2016-07-01 15:39:40 +0530
committerharpreet2016-07-01 15:39:40 +0530
commitb1cc274017b86588a747522a0291c433ed8290e8 (patch)
tree14055f638270bf5360feb570da654467f1ee976c
parent89b96cb79cbe75ba8c1afea61b3caca37a083f62 (diff)
downloadFOSSEE-Optimization-toolbox-b1cc274017b86588a747522a0291c433ed8290e8.tar.gz
FOSSEE-Optimization-toolbox-b1cc274017b86588a747522a0291c433ed8290e8.tar.bz2
FOSSEE-Optimization-toolbox-b1cc274017b86588a747522a0291c433ed8290e8.zip
Readme Updated
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 281be0c..02930ef 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,21 @@ A toolbox that provides mixed integer linear programming, quadratic programming
Tested with Symphony 5.6.10, Ipopt 3.12.4 and Scilab 5.5.2
+##To Download
+1. Go to the link `http://or.fossee.in/resources/downloads`
+2. Select the linux or windows version as per your platform.
+3. Extract the files.
+
## To use:
1. In Scilab, change the working directory to the root directory of the repository
-2. Run `exec loader.sce`
-3. The Toolbox is now ready.
+2. Run `exec loader.sce` in the scilab console.
+3. The Toolbox is now ready, to see help type `help FOSSEE Optimization Toolbox` in console.
+4. The demos are in `Demos folder`.
+5. To run a demo type `exec <name of function>.dem.sce`
+6. Test cases are in `tests folder`.
-## Note: This version is only for linux.
+## To build
+1. If you have updated the source code then you need to build it again to see the changes.
+2. To build it first unlink the toolbox by executing the following command `ulink`.
+3. Then type `exec builder.sce` to run the builder. {Prerequisites: In windows you need Visual Studio}
+4. Now just run `exec loader.sce` in the scilab console. It will be ready to use.