diff --git a/.gitmodules b/.gitmodules index aa86933..d8ab27a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +1,3 @@ [submodule "osqp_sources"] path = osqp_sources - url = https://github.com/oxfordcontrol/osqp - branch = dev-0.3.1 \ No newline at end of file + url = https://github.com/osqp/osqp diff --git a/README.md b/README.md index b5c7fb2..019152a 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/package/README.md b/package/README.md index a9768cb..84aa2bb 100644 --- a/package/README.md +++ b/package/README.md @@ -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-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).