-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from osqp/readme_fixes
Updated README; updated submodule path
- Loading branch information
Showing
3 changed files
with
18 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |