Skip to content

Commit

Permalink
Merge pull request #45 from osqp/readme_fixes
Browse files Browse the repository at this point in the history
Updated README; updated submodule path
  • Loading branch information
vineetbansal authored Sep 13, 2021
2 parents fb96c28 + 15bc985 commit 57a5c28
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
3 changes: 1 addition & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[submodule "osqp_sources"]
path = osqp_sources
url = https://github.com/oxfordcontrol/osqp
branch = dev-0.3.1
url = https://github.com/osqp/osqp
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Matlab interface for OSQP

[![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)
[![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)

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

Expand Down
20 changes: 16 additions & 4 deletions package/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Matlab Interface packaging functions

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

You need:
```
git submodule update --init --recursive
```

- `Curl` command installed
- The Bintray token
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.
This can also be done on the command line:

```
/path/to/matlab -nodisplay -nosplash -nodesktop -r "cd package; package_osqp(); exit;"
```

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

```
/path/to/matlab -nodisplay -nosplash -nodesktop -r "cd package; package_osqp('0.6.2'); exit;"
```

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 comments on commit 57a5c28

Please sign in to comment.