Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for JavaScript/WebAssembly bindings #304

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DominikPeters
Copy link

I've coded up a WebAssembly version of SCS that can be run in the browser. In this pull request, I'm proposing to add documentation of these bindings to the scs docs.

A compiled version of the docs including my local additions is here:
https://dominik-peters.de/github/scs/

I added three pages:

  • installation which can be done via the npm repository with npm install scs-solver,
  • API which is very close to the C/C++ interface,
  • Examples including a live demo which works by including the solver from a CDN using a <script> tag.

Here is a screenshot of the "live demo" on the example page:
recording15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant