Skip to content

Commit 57a5c28

Browse files
authored
Merge pull request #45 from osqp/readme_fixes
Updated README; updated submodule path
2 parents fb96c28 + 15bc985 commit 57a5c28

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

.gitmodules

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
[submodule "osqp_sources"]
22
path = osqp_sources
3-
url = https://github.com/oxfordcontrol/osqp
4-
branch = dev-0.3.1
3+
url = https://github.com/osqp/osqp

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Matlab interface for OSQP
22

3-
[![Matlab Interface Tests](https://github.com/oxfordcontrol/osqp-matlab/actions/workflows/ci.yml/badge.svg)](https://github.com/oxfordcontrol/osqp-matlab/actions/workflows/ci.yml)
3+
[![Test](https://github.com/osqp/osqp-matlab/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/osqp/osqp-matlab/actions/workflows/main.yml)
44

55
Matlab wrapper for [OSQP](https://osqp.org/): the Operator Splitting QP Solver.
66

package/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
# Matlab Interface packaging functions
22

3-
Simply run `package_osqp.m`. It will compile the interface, package it and upload it to the GitHub release.
3+
Make sure you have `cmake` on your path, and have cloned the entire source tree (including submodules) locally.
44

5-
You need:
5+
```
6+
git submodule update --init --recursive
7+
```
68

7-
- `Curl` command installed
8-
- The Bintray token
9+
Then simply run `package_osqp.m` from within MATLAB. This will compile the interface and package it as a `osqp-matlab-<platform>64.tar.gz` file.
10+
This can also be done on the command line:
911

12+
```
13+
/path/to/matlab -nodisplay -nosplash -nodesktop -r "cd package; package_osqp(); exit;"
14+
```
1015

16+
Additionally, you can pass a version number to the `package_osqp` function. This is done automatically for the Linux
17+
platform by Github actions (by looking at the release tag), but would have to be done manually for Windows/MacOS. For example,
1118

19+
```
20+
/path/to/matlab -nodisplay -nosplash -nodesktop -r "cd package; package_osqp('0.6.2'); exit;"
21+
```
22+
23+
Once the `.tar.gz` files for Windows/MacOS have been generated, upload them manually to the appropriate release as assets (Release -> Edit -> Upload files).

0 commit comments

Comments
 (0)