Skip to content

Commit

Permalink
Docs update 1.0.2381
Browse files Browse the repository at this point in the history
  • Loading branch information
cesaref committed Mar 13, 2024
1 parent be84451 commit f9c2f69
Show file tree
Hide file tree
Showing 26 changed files with 4,476 additions and 22 deletions.
2 changes: 1 addition & 1 deletion assets/example_patches/808/cmaj_808.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
// patch '808.cmajorpatch'.
//
// This file was auto-generated by the Cmajor toolkit v1.0.2380
// This file was auto-generated by the Cmajor toolkit v1.0.2381
//
// To use it, import this module into your HTML/Javascript code and call
// `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection
Expand Down
23 changes: 23 additions & 0 deletions assets/example_patches/CompuFart/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### Auto-generated HTML & Javascript for Cmajor Patch "CompuFart"

This folder contains some self-contained HTML/Javascript files that play and show a Cmajor
patch using WebAssembly and WebAudio.

For `index.html` to display correctly, this folder needs to be served as HTTP, so if you're
running it locally, you'll need to start a webserver that serves this folder, and then
point your browser at whatever URL your webserver provides. For example, you could run
`python3 -m http.server` in this folder, and then browse to the address it chooses.

The files have all been generated using the Cmajor command-line tool:
```
cmaj generate --target=webaudio --output=<location of this folder> <path to the .cmajorpatch file to convert>
```

- `index.html` is a minimal page that creates the javascript object that implements the patch,
connects it to the default audio and MIDI devices, and displays its view.
- `cmaj_CompuFart.js` - this is the Javascript wrapper class for the patch, encapsulating its
DSP as webassembly, and providing an API that is used to both render the audio and
control its properties.
- `cmaj_api` - this folder contains javascript helper modules and resources.

To learn more about Cmajor, visit [cmajor.dev](cmajor.dev)
Loading

0 comments on commit f9c2f69

Please sign in to comment.