search

crucialfelix / supercolliderjs

The JavaScript client library for SuperCollider
https://crucialfelix.github.io/supercolliderjs/
MIT License
472 stars 41 forks source link

document sclang #62

Open htor opened 4 years ago

htor commented 4 years ago

hi! i couldn't find any docs on sclang (only server) in the docs: https://crucialfelix.github.io/supercolliderjs/api/

it would be nice to have basic documentation on sclang, like for instance arguments to sclang.boot and sclang.interpret, and events: 'stdout', 'stderr', 'error' ...

crucialfelix commented 4 years ago

I'm working on the new document branch right now. There is a generated TypeDoc site for each package, but it still doesn't look very good. It is kind of corporate style :(

I also found one bug in the alpha.0 release. I will do another alpha release and if you could try that out it would be very helpful

crucialfelix commented 4 years ago

WIP feature: https://github.com/crucialfelix/supercolliderjs/tree/feature/docs

htor commented 4 years ago

I'm working on the new document branch right now. There is a generated TypeDoc site for each package, but it still doesn't look very good. It is kind of corporate style :(

ah, nice coincidence! excited to see the release coming slowly up. maybe a little css can fix the corporation-style? how do i spin up the generated sites on my machine?

I also found one bug in the alpha.0 release. I will do another alpha release and if you could try that out it would be very helpful

a bug with documentation or something else? i can test whatever, just let me know.

crucialfelix commented 4 years ago

Current state: https://crucialfelix.github.io/supercolliderjs/#/packages/lang/README

I will still add some more in a future round with more of the internals (subscribing to events etc.)