In most cases it's highly recommended that you use the hosted version from http://connect.soundcloud.com/sdk.js in your website. This README provides development-related information.
- - coffee-script
- - uglify-js
- - jslint
To check out the repository locally and initialize all submodules in
To build the release version in
build/, just run:
$ make build
To run the tests or use
sdk.js, run this from either the top level of your repo or
sdk.js will automatically compile all coffeescript files in
src/ on the fly when loaded.
sdk.js to work it must be accessed from
http://connect.soundcloud.dev instead of
To run the tests, just start an HTTP server in the project root and navigate to
In development mode the tests will automatically compile the coffeescript on each reload.
In build mode the tests will laod the compiled sdk.js.
build/— contains compiled JS (as it's hosted on http://connect.soundcloud.com)
src/— contains coffeescript source code
vendor/— includes git submodules of external projects
test/— tests live here
examples/— here there be examples