wasm : add note about worker.js file generation [no ci] (#3133)

This commit updates the documentation for the WASM examples to include a
note about the generation of the `worker.js` file. As of Emscripten
3.1.58 (April 2024), separate worker.js files are no longer generated
and the worker is embedded in the main JS file.

The motivation for this change is to inform users about the new behavior
of Emscripten and why the `worker.js` file may not be present.

Refs: https://github.com/ggml-org/whisper.cpp/issues/3123

diff --git a/examples/bench.wasm/README.md b/examples/bench.wasm/README.md
index 2b7a95d3e15f6d68541e0de34d24280119d2aa8e..726d4d08e0ae7fbf7b1860ab792ea1cc75de0d56 100644 (file)
--- a/examples/bench.wasm/README.md
+++ b/examples/bench.wasm/README.md
@@ -28,5 +28,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/bench.wasm/*       /path/to/html/
+cp bin/libbench.js        /path/to/html/
 cp bin/libbench.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.

diff --git a/examples/command.wasm/README.md b/examples/command.wasm/README.md
index 3e55dd0dc62ccd45b3df7f895435047c19dd56e6..78d8776f5705f76ebd08a33850278e239a60a92d 100644 (file)
--- a/examples/command.wasm/README.md
+++ b/examples/command.wasm/README.md
@@ -28,5 +28,10 @@ To run the example in a different server, you need to copy the following files
 to the server's HTTP path:
 ```
 cp bin/command.wasm/*       /path/to/html/
+cp bin/libcommand.js        /path/to/html/
 cp bin/libcommand.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.

diff --git a/examples/stream.wasm/README.md b/examples/stream.wasm/README.md
index 26912c4935cc7bc4498f2910750c18a42a2e3b30..f3c0c3d75826c8e20755949c6d43086618b838f9 100644 (file)
--- a/examples/stream.wasm/README.md
+++ b/examples/stream.wasm/README.md
@@ -26,5 +26,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/stream.wasm/*       /path/to/html/
+cp bin/libstream.js        /path/to/html/
 cp bin/libstream.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.

diff --git a/examples/whisper.wasm/README.md b/examples/whisper.wasm/README.md
index 1309cf3620789888be2af074b3fc983d009625ff..f1bb7cadde2aaa04fcdf246603a73ad019b852f2 100644 (file)
--- a/examples/whisper.wasm/README.md
+++ b/examples/whisper.wasm/README.md
@@ -48,5 +48,10 @@ to the server's HTTP path:
 ```
 # copy the produced page to your HTTP path
 cp bin/whisper.wasm/*    /path/to/html/
+cp bin/libmain.js        /path/to/html/
 cp bin/libmain.worker.js /path/to/html/
 ```
+
+> 📝 **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
+> longer generated and the worker is embedded in the main JS file. So the worker
+> file will not be geneated for versions later than `3.1.58`.