danbev commited on
Commit
c6a619d
Β·
unverified Β·
1 Parent(s): c4aa3ee

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

Browse files

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

examples/bench.wasm/README.md CHANGED
@@ -28,5 +28,10 @@ to the server's HTTP path:
28
  ```
29
  # copy the produced page to your HTTP path
30
  cp bin/bench.wasm/* /path/to/html/
 
31
  cp bin/libbench.worker.js /path/to/html/
32
  ```
 
 
 
 
 
28
  ```
29
  # copy the produced page to your HTTP path
30
  cp bin/bench.wasm/* /path/to/html/
31
+ cp bin/libbench.js /path/to/html/
32
  cp bin/libbench.worker.js /path/to/html/
33
  ```
34
+
35
+ > πŸ“ **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
36
+ > longer generated and the worker is embedded in the main JS file. So the worker
37
+ > file will not be geneated for versions later than `3.1.58`.
examples/command.wasm/README.md CHANGED
@@ -28,5 +28,10 @@ To run the example in a different server, you need to copy the following files
28
  to the server's HTTP path:
29
  ```
30
  cp bin/command.wasm/* /path/to/html/
 
31
  cp bin/libcommand.worker.js /path/to/html/
32
  ```
 
 
 
 
 
28
  to the server's HTTP path:
29
  ```
30
  cp bin/command.wasm/* /path/to/html/
31
+ cp bin/libcommand.js /path/to/html/
32
  cp bin/libcommand.worker.js /path/to/html/
33
  ```
34
+
35
+ > πŸ“ **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
36
+ > longer generated and the worker is embedded in the main JS file. So the worker
37
+ > file will not be geneated for versions later than `3.1.58`.
examples/stream.wasm/README.md CHANGED
@@ -26,5 +26,10 @@ to the server's HTTP path:
26
  ```
27
  # copy the produced page to your HTTP path
28
  cp bin/stream.wasm/* /path/to/html/
 
29
  cp bin/libstream.worker.js /path/to/html/
30
  ```
 
 
 
 
 
26
  ```
27
  # copy the produced page to your HTTP path
28
  cp bin/stream.wasm/* /path/to/html/
29
+ cp bin/libstream.js /path/to/html/
30
  cp bin/libstream.worker.js /path/to/html/
31
  ```
32
+
33
+ > πŸ“ **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
34
+ > longer generated and the worker is embedded in the main JS file. So the worker
35
+ > file will not be geneated for versions later than `3.1.58`.
examples/whisper.wasm/README.md CHANGED
@@ -48,5 +48,10 @@ to the server's HTTP path:
48
  ```
49
  # copy the produced page to your HTTP path
50
  cp bin/whisper.wasm/* /path/to/html/
 
51
  cp bin/libmain.worker.js /path/to/html/
52
  ```
 
 
 
 
 
48
  ```
49
  # copy the produced page to your HTTP path
50
  cp bin/whisper.wasm/* /path/to/html/
51
+ cp bin/libmain.js /path/to/html/
52
  cp bin/libmain.worker.js /path/to/html/
53
  ```
54
+
55
+ > πŸ“ **Note:** As of Emscripten 3.1.58 (April 2024), separate worker.js files are no
56
+ > longer generated and the worker is embedded in the main JS file. So the worker
57
+ > file will not be geneated for versions later than `3.1.58`.