@grame/faustwasm 0.4.3 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -59,23 +59,26 @@ node scripts/faust2wasm.js test/poly.dsp test/out -poly
59
59
  ```
60
60
  will create a set of files: `poly.js`, `poly.wasm`, `poly.json`, `poly.html` (and possibly `poly_effect.wasm`, `poly_effect.json`) in the `out` folder.
61
61
 
62
+
63
+ #### Creating a Progressive Web Application of a Faust DSP
64
+
62
65
  You can create a standalone Progressive Web Application using the same command line:
63
66
 
64
67
  ```bash
65
- rm -rf test/out # make sure you are under the faustwasm directory.
66
- node scripts/faust2wasm.js test/rev.dsp test/out -standalone
68
+ node scripts/faust2wasm.js test/rev.dsp test/rev -standalone
67
69
  ```
68
- will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `rev.js`, `rev.wasm`, `rev.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder.
70
+ will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `rev.js`, `rev.wasm`, `rev.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `rev` folder.
69
71
 
70
- The folder contains the necessary ressources to deploy the Faust application as a PWA on a server, to be installed and used offline. Note that audio files used by the `soundfile` primitives in the DSP code will have to be mannually added in the folder.
72
+ The folder contains the necessary ressources to deploy the Faust application as a PWA on a server, to be installed and used offline. Note that audio files used by the `soundfile` primitives in the DSP code will have to be mannually added in the folder. To test, be sure to launch a local web server at the `test` folder level, then go inside `test\rev` folder.
71
73
 
72
74
  A standalone polyphonic and MIDI standalone Progressive Web Application can be created with:
73
75
 
74
76
  ```bash
75
- rm -rf test/out # make sure you are under the faustwasm directory.
76
- node scripts/faust2wasm.js test/organ1.dsp test/out -standalone
77
+ node scripts/faust2wasm.js test/organ1.dsp test/organ1 -poly -standalone
77
78
  ```
78
- will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `organ1.js`, `organ1.wasm`, `organ1.json`, `organ1_effect.wasm`, `organ1_effect.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder.
79
+ will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `organ1.js`, `organ1.wasm`, `organ1.json`, `organ1_effect.wasm`, `organ1_effect.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `organ1` folder.
80
+
81
+ To test, be sure to launch a local web server at the `test` folder level, then go inside `test\organ1` folder.
79
82
 
80
83
  #### Generate SVG Diagrams of a Faust DSP
81
84
 
@@ -235,6 +238,8 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
235
238
 
236
239
  ### Projects examples
237
240
 
241
+ Several examples can be tested by launching a local web server at the faustwasm root level, and going in `test/faustlive-wasm` and `libfaust-in-worklet` folders.
242
+
238
243
  The package is used in the following projects:
239
244
 
240
245
  - [faust-web-component](https://github.com/grame-cncm/faust-web-component), a package providing two web components for embedding interactive Faust snippets in web pages.