From 7754c07f17191612a735727f5bc0924073ae5306 Mon Sep 17 00:00:00 2001 From: pca006132 Date: Sat, 30 Nov 2024 00:25:39 +0800 Subject: [PATCH] readme changes --- .github/workflows/manifold.yml | 2 +- README.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/manifold.yml b/.github/workflows/manifold.yml index 93fb746c7..7c9d93e47 100644 --- a/.github/workflows/manifold.yml +++ b/.github/workflows/manifold.yml @@ -137,7 +137,7 @@ jobs: source ./emsdk/emsdk_env.sh mkdir build cd build - emcmake cmake -DCMAKE_BUILD_TYPE=Release -DMANIFOLD_PAR=${{matrix.parallelization}} .. && emmake make + emcmake cmake -DCMAKE_BUILD_TYPE=MinSizeRel -DMANIFOLD_PAR=${{matrix.parallelization}} .. && emmake make - name: Test WASM if: matrix.parallelization == 'OFF' run: | diff --git a/README.md b/README.md index 5ff2c02a8..e5d02095d 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,10 @@ The build instructions used by our CI are in [manifold.yml](https://github.com/e ### WASM +> Note: While we support compiling with `MANIFOLD_PAR=ON` in recent emscripten +> versions, this is not recommended as there can potentially be memory +> corruption issues. + To build the JS WASM library, first install NodeJS and set up emscripten: (on Mac): @@ -158,7 +162,7 @@ Then build: cd manifold mkdir buildWASM cd buildWASM -emcmake cmake -DCMAKE_BUILD_TYPE=Release .. && emmake make +emcmake cmake -DCMAKE_BUILD_TYPE=MinSizeRel .. && emmake make node test/manifold_test.js ```