Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(common): linux and macOS emscripten setup #12701

Merged
merged 3 commits into from
Nov 28, 2024
Merged

docs(common): linux and macOS emscripten setup #12701

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a53c89
docs(windows): update emscripten bash setup
rc-swag Nov 26, 2024
f18bba2
docs(linux): update emscripten bash setup
rc-swag Nov 26, 2024
d86e499
docs(common): apply review comments
rc-swag Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/build/linux-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
rc-swag marked this conversation as resolved.
Show resolved Hide resolved
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`.
>
Expand Down
13 changes: 13 additions & 0 deletions docs/build/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
rc-swag marked this conversation as resolved.
Show resolved Hide resolved
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]
Expand Down
23 changes: 18 additions & 5 deletions docs/build/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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...`
Expand Down Expand Up @@ -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]
Expand All @@ -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**:
Expand All @@ -196,7 +209,7 @@ SETX EMSCRIPTEN_BASE "<your-emsdk-path>\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
Expand Down Expand Up @@ -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
Expand Down
Loading