make documentation easier to access
Opened this issue · 1 comments
I don't see it anywhere in the readme. I see that I can do make docs
, but I get module import errors from node.
$ make docs
./build update docs
module.js:340
throw err;
^
Error: Cannot find module 'paramon'
at Function.Module._resolveFilename (module.js:338:15)
at Function.Module._load (module.js:280:25)
at Module.require (module.js:362:17)
at require (module.js:378:17)
at Object.<anonymous> (/home/josh/dev/sink.js/build:41:16)
at Module._compile (module.js:449:26)
at Object.Module._extensions..js (module.js:467:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.runMain (module.js:487:10)
make: *** [DOCS.md] Error 1
So i tried npm install paramon
, but then I get a different module import error for script-builder
. ugh.
Isn't there some webpage I can go to for prebuilt documentation? Or could you make a package.json with your npm dependencies? Come to think of it, it'd be nice to depend on sink.js through the npm registry.
This all started with my ignorance of how to make the example sinks stop playing sound. Turns out the answer is sink.kill()
, which I ended up guessing by looking through chrome's listing of the object's properties.
Hmm... turns out kill
isn't even in the DOCS.md
once I did get all the npm modules installed. How am I supposed to stop a sink? Am I misunderstanding the basic purpose of this project? I want to (at the moment) make a web page with a piano-like keyboard that plays sine waves. So naturally I would need the ability to stop the sound from each key.