Docs update 1.0.2633

cmajor-lang · Sep 2, 2024 · 19f76f4 · 19f76f4
1 parent 022b2a3
commit 19f76f4
Show file tree

Hide file tree

Showing 60 changed files with 5,776 additions and 17 deletions.
diff --git a/assets/example_patches/808/cmaj_808.js b/assets/example_patches/808/cmaj_808.js
@@ -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.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/CompuFart/cmaj_CompuFart.js b/assets/example_patches/CompuFart/cmaj_CompuFart.js
@@ -3,7 +3,7 @@
 //  This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
 //  patch 'CompuFartSynth.cmajorpatch'.
 //
-//  This file was auto-generated by the Cmajor toolkit v1.0.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/ElectricPiano/cmaj_Electric_Piano.js b/assets/example_patches/ElectricPiano/cmaj_Electric_Piano.js
diff --git a/assets/example_patches/GuitarLSTM/cmaj_GuitarLSTM.js b/assets/example_patches/GuitarLSTM/cmaj_GuitarLSTM.js
diff --git a/assets/example_patches/HelloWorld/cmaj_Hello_World.js b/assets/example_patches/HelloWorld/cmaj_Hello_World.js
@@ -3,7 +3,7 @@
 //  This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
 //  patch 'HelloWorld.cmajorpatch'.
 //
-//  This file was auto-generated by the Cmajor toolkit v1.0.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/Piano/cmaj_Piano.js b/assets/example_patches/Piano/cmaj_Piano.js
@@ -3,7 +3,7 @@
 //  This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
 //  patch 'Piano.cmajorpatch'.
 //
-//  This file was auto-generated by the Cmajor toolkit v1.0.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/PirkleFilters/cmaj_vafilters.js b/assets/example_patches/PirkleFilters/cmaj_vafilters.js
diff --git a/assets/example_patches/Pro54/cmaj_Pro54.js b/assets/example_patches/Pro54/cmaj_Pro54.js
@@ -3,7 +3,7 @@
 //  This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
 //  patch 'Pro54.cmajorpatch'.
 //
-//  This file was auto-generated by the Cmajor toolkit v1.0.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/Replicant/cmaj_Replicant.js b/assets/example_patches/Replicant/cmaj_Replicant.js
diff --git a/assets/example_patches/RingMod/cmaj_Ring_Mod_Demo.js b/assets/example_patches/RingMod/cmaj_Ring_Mod_Demo.js
@@ -3,7 +3,7 @@
 //  This file contains a Javascript/Webassembly/WebAudio export of the Cmajor
 //  patch 'RingMod.cmajorpatch'.
 //
-//  This file was auto-generated by the Cmajor toolkit v1.0.2632
+//  This file was auto-generated by the Cmajor toolkit v1.0.2633
 //
 //  To use it, import this module into your HTML/Javascript code and call
 //  `createAudioWorkletNodePatchConnection()`. The AudioWorkletPatchConnection

diff --git a/assets/example_patches/STunedBar6/cmaj_STunedBar6.js b/assets/example_patches/STunedBar6/cmaj_STunedBar6.js
diff --git a/assets/example_patches/SubtractOne/README.md b/assets/example_patches/SubtractOne/README.md
@@ -0,0 +1,23 @@
+### Auto-generated HTML & Javascript for Cmajor Patch "SubtractOne"
+
+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_SubtractOne.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)