update documentation

PREDICT-EPFL · Jun 18, 2024 · 4aa61fa · 4aa61fa
1 parent bc4d25a
commit 4aa61fa
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 57 deletions.
diff --git a/docs/interfaces/c_cpp/installation.md b/docs/interfaces/c_cpp/installation.md
@@ -12,9 +12,9 @@ nav_order: 1
 
 ### Building and Installing PIQP
 
-* Clone PIQP from Github recursively
+* Clone PIQP from Github
 ```shell
-git clone https://github.com/PREDICT-EPFL/piqp.git --recurse-submodules
+git clone https://github.com/PREDICT-EPFL/piqp.git
 ```
 * Build PIQP in a `build` folder
 ```shell

diff --git a/docs/interfaces/matlab/getting_started.md b/docs/interfaces/matlab/getting_started.md
@@ -1,9 +1,9 @@
 ---
 title: Getting Started
 layout: default
-parent: Matlab
+parent: Matlab / Octave
 grand_parent: Interfaces
-nav_order: 2
+nav_order: 3
 ---
 
 {% root_include _common/problem_formulation.md %}

diff --git a/docs/interfaces/matlab/index.md b/docs/interfaces/matlab/index.md
@@ -1,5 +1,5 @@
 ---
-title: Matlab
+title: Matlab / Octave
 layout: default
 nav_order: 3
 parent: Interfaces

diff --git a/docs/interfaces/matlab/installation.md → .../interfaces/matlab/installation_matlab.md b/docs/interfaces/matlab/installation.md → .../interfaces/matlab/installation_matlab.md
@@ -1,7 +1,7 @@
 ---
-title: Installation 
+title: Installation (Matlab)
 layout: default
-parent: Matlab
+parent: Matlab / Octave
 grand_parent: Interfaces
 nav_order: 1
 ---
@@ -21,9 +21,9 @@ install_piqp
 
 ### Building and Installing PIQP
 
-* Clone PIQP from Github recursively
+* Clone PIQP from Github
 ```shell
-git clone https://github.com/PREDICT-EPFL/piqp.git --recurse-submodules
+git clone https://github.com/PREDICT-EPFL/piqp.git
 ```
 * Build the interface in Matlab by executing the following commands
 ```matlab

diff --git a/docs/interfaces/matlab/installation_octave.md b/docs/interfaces/matlab/installation_octave.md
@@ -0,0 +1,37 @@
+---
+title: Installation (Octave)
+layout: default
+parent: Matlab / Octave
+grand_parent: Interfaces
+nav_order: 2
+---
+
+## Installing package
+
+PIQP can be directly installed running the following command
+
+```matlab
+pkg install "https://github.com/PREDICT-EPFL/piqp/releases/latest/download/piqp-octave.tar.gz"
+```
+
+Before using PIQP in Octave make sure to load it in your script with
+```matlab
+pkg load piqp
+```
+
+## Building and Installing from Source
+
+* Clone PIQP from Github
+```shell
+git clone https://github.com/PREDICT-EPFL/piqp.git
+```
+* Package PIQP in Octave by executing the following commands
+```matlab
+cd interfaces/octave
+package_piqp
+```
+This will download all dependencies and package the Octave interface into a `piqp-octave.tar.gz` file.
+You can then install the package with
+```matlab
+pkg install piqp-octave.tar.gz
+```
diff --git a/docs/interfaces/octave/index.md b/docs/interfaces/octave/index.md
diff --git a/docs/interfaces/octave/installation.md b/docs/interfaces/octave/installation.md
diff --git a/docs/interfaces/python/installation.md b/docs/interfaces/python/installation.md
@@ -28,9 +28,9 @@ conda install -c conda-forge piqp
 
 ### Building and Installing PIQP
 
-* Clone PIQP from Github recursively
+* Clone PIQP from Github
 ```shell
-git clone https://github.com/PREDICT-EPFL/piqp.git --recurse-submodules
+git clone https://github.com/PREDICT-EPFL/piqp.git
 ```
 * Building and installing PIQP
 ```shell