summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index a71e086..e85e274 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
-intfminfunction
+# FOSSEE Optimization Toolbox for Scilab
+
+A toolbox that provides mixed integer linear, quadratic and non linear programming tools in Scilab through the CBC and Bonmin libraries.
+
+Tested with CBC 2.9.8, Bonmin 1.8.4 and Scilab 5.5.2
+
+## To use:
+1. In Scilab, change the working directory to the root directory of the repository
+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`.
+
+## 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.