summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md36
-rw-r--r--readme.txt1
2 files changed, 36 insertions, 1 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c56c93
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# FOSSEE Scilab Octave Toolbox
+
+This is a scilab toolbox to call octave functions. It requires octave to be installed on the system.
+
+## This toolbox has been built and tested using
+1. `OS - Linux Debian 10, Ubuntu 18.10 (64-bit)`
+2. `Octave - Version 4.4.1, 5.1.0`
+3. `Scilab - Version 6.0.1`
+
+## Installation instructions:
+Run the following commands in the linux terminal
+1. `sudo apt-get install build-essential (~117 MB download)`
+2. `sudo apt-get install liboctave-dev (~103 MB download)`
+3. `sudo apt-get install octave`
+4. `sudo apt-get install scilab`
+
+## Install the required octave packages using the below command in linux terminal
+ `sudo apt-get install octave-<pkg name>`
+ For example, to install signal package in octave, do
+ `sudo apt-get install octave-signal`
+
+## Launch Scilab and run the following commands inside the scilab console
+1. `cd <path to fossee-scilab-octave-toolbox directory>`
+2. `exec builder.sce`
+3. `exec loader.sce`
+4. `help octave_fun` (then execute the examples appearing on the help page to test the toolbox)
+
+## In case if executing the builder and loader files in scilab throw an error regarding .so files, you probably need to build the toolbox from source. Do the following on the linux terminal
+1. Download the fossee-scilab-octave-toolbox source from [`atoms.scilab.org`](https://atoms.scilab.org)
+2. Close scilab, if running
+3. `cd <path to fossee-scilab-octave-toolbox/src/ directory>`
+4. `make clean`
+5. `make`
+6. `make install`
+
+
diff --git a/readme.txt b/readme.txt
deleted file mode 100644
index 52c254a..0000000
--- a/readme.txt
+++ /dev/null
@@ -1 +0,0 @@
-This is a scilab toolbox to call octave functions