From b5672e8e8d42b0278d1765ab3d24c97b0e746bd0 Mon Sep 17 00:00:00 2001
From: assiduous <assiduous@diligentgraphics.com>
Date: Tue, 23 Apr 2024 13:17:38 -0700
Subject: [PATCH] readme: added a note about STACK_SIZE Emscripten compiler
 setting

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 5493ff90..cac2352b 100644
--- a/README.md
+++ b/README.md
@@ -237,6 +237,10 @@ Use the steps in [Build Steps](#build-steps), with the following notes/exception
 * For a standalone JS/WASM library, turn on `-DENABLE_GLSLANG_JS=ON`.
 * To get a fully minimized build, make sure to use `brotli` to compress the .js
   and .wasm files
+* Note that by default, Emscripten allocates a very small stack size, which may
+  cause stack overflows when compiling large shaders. Use the
+  [STACK_SIZE](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#stack-size)
+  compiler setting to increase the stack size.
 
 Example: