From 7a53c892778ca9019ceecc5718a803db2e419fc9 Mon Sep 17 00:00:00 2001 From: rc-swag <58423624+rc-swag@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:13:16 +1000 Subject: [PATCH 1/3] docs(windows): update emscripten bash setup --- docs/build/windows.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/build/windows.md b/docs/build/windows.md index 3168bcd0ae0..63a77d1c41a 100644 --- a/docs/build/windows.md +++ b/docs/build/windows.md @@ -137,7 +137,7 @@ SETX KEYMAN_ROOT "c:\Projects\keyman\keyman" ``` > [!NOTE] -> The `SETX` command will set persistent environment variables but they do not +> The `SETX` command will set persistent environment variables but they do not > impact the current shell environment. Start a new shell to see the variables. > [!TIP] @@ -147,7 +147,7 @@ SETX KEYMAN_ROOT "c:\Projects\keyman\keyman" > > You can alternatively use Windows Settings to add these environment variables > permanently: -> +> > 1. In Windows Search, type "environment" and select "Edit System Environment > Variables" > 2. Click `Environment Variables...` @@ -175,6 +175,19 @@ git clone https://github.com/emscripten-core/emsdk cd emsdk emsdk install 3.1.58 emsdk activate 3.1.58 +cd upstream/emscripten +npm install +``` + +If you are updating an existing install of Emscripten: + +```bash +cd emsdk +git pull +emsdk install 3.1.58 +emsdk activate 3.1.58 +cd upstream/emscripten +npm install ``` > ![WARNING] @@ -185,7 +198,7 @@ emsdk activate 3.1.58 There is no need to add emscripten to the path in order to build Keyman. However, you should set the `EMSCRIPTEN_BASE` variable to the path where `emcc` -can be found, in the `upstream\emscripten` subdirectory of where you installed +can be found, in the `upstream\emscripten` subdirectory of where you installed emsdk. **Environment variables**: @@ -196,7 +209,7 @@ SETX EMSCRIPTEN_BASE "\upstream\emscripten" **Optional environment variables**: -To let the Keyman build scripts control the version of Emscripten +To let the Keyman build scripts control the version of Emscripten installed on your computer: ```bat @@ -259,7 +272,7 @@ of appropriate node versions during builds. ```ps1 choco install visualstudio2019community visualstudio2019-workload-nativedesktop visualstudio2019buildtools ``` - + * Verify required build tools are installed * Run `Visual Studio Installer` * Check the `Individual components` tab From f18bba2781a17af9ace107a048ac1d0eea805fe1 Mon Sep 17 00:00:00 2001 From: rc-swag <58423624+rc-swag@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:20:43 +1000 Subject: [PATCH 2/3] docs(linux): update emscripten bash setup Update the linux and macos bash setup to documents. --- docs/build/linux-ubuntu.md | 13 +++++++++++++ docs/build/macos.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index a45d9390ba5..a7f15a29e0c 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -70,10 +70,23 @@ git clone https://github.com/emscripten-core/emsdk.git cd emsdk ./emsdk install 3.1.58 ./emsdk activate 3.1.58 +cd upstream/emscripten +npm install export EMSCRIPTEN_BASE="$(pwd)/upstream/emscripten" echo "export EMSCRIPTEN_BASE=\"$EMSCRIPTEN_BASE\"" >> .bashrc ``` +If you are updating an existing install of Emscripten: + +```bash +cd emsdk +git pull +./emsdk install 3.1.58 +./emsdk activate 3.1.58 +cd upstream/emscripten +npm install +``` + > ![WARNING] > Don't put EMSDK on the path, i.e. don't source `emsdk_env.sh`. > diff --git a/docs/build/macos.md b/docs/build/macos.md index 25b0c1f82ae..2baf0d5831a 100644 --- a/docs/build/macos.md +++ b/docs/build/macos.md @@ -101,10 +101,23 @@ git clone https://github.com/emscripten-core/emsdk cd emsdk emsdk install 3.1.58 emsdk activate 3.1.58 +cd upstream/emscripten +npm install export EMSCRIPTEN_BASE="$(pwd)/upstream/emscripten" echo "export EMSCRIPTEN_BASE=\"$EMSCRIPTEN_BASE\"" >> .bashrc ``` +If you are updating an existing install of Emscripten: + +```bash +cd emsdk +git pull +emsdk install 3.1.58 +emsdk activate 3.1.58 +cd upstream/emscripten +npm install +``` + You will want to add `EMSCRIPTEN_BASE` to your .bashrc. > ![WARNING] From d86e499f9c81cff862ff2b15ffcc983e0bb356d9 Mon Sep 17 00:00:00 2001 From: rc-swag <58423624+rc-swag@users.noreply.github.com> Date: Tue, 26 Nov 2024 18:47:44 +1000 Subject: [PATCH 3/3] docs(common): apply review comments Co-authored-by: Eberhard Beilharz Co-authored-by: Marc Durdin --- docs/build/linux-ubuntu.md | 2 +- docs/build/macos.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index a7f15a29e0c..37b2aafa1ab 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -72,7 +72,7 @@ cd emsdk ./emsdk activate 3.1.58 cd upstream/emscripten npm install -export EMSCRIPTEN_BASE="$(pwd)/upstream/emscripten" +export EMSCRIPTEN_BASE="$(pwd)" echo "export EMSCRIPTEN_BASE=\"$EMSCRIPTEN_BASE\"" >> .bashrc ``` diff --git a/docs/build/macos.md b/docs/build/macos.md index 2baf0d5831a..f961942070b 100644 --- a/docs/build/macos.md +++ b/docs/build/macos.md @@ -103,7 +103,7 @@ emsdk install 3.1.58 emsdk activate 3.1.58 cd upstream/emscripten npm install -export EMSCRIPTEN_BASE="$(pwd)/upstream/emscripten" +export EMSCRIPTEN_BASE="$(pwd)" echo "export EMSCRIPTEN_BASE=\"$EMSCRIPTEN_BASE\"" >> .bashrc ```