Skip to content

Fix wasm build instructions #230

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

Merged
merged 7 commits into from
Jan 22, 2025
Merged

Fix wasm build instructions #230

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7fd34b9
Fix instructions for using emsdk
mcbarton Jan 20, 2025
33fc5af
Fix micromamba activate command wasm build instructions
mcbarton Jan 20, 2025
88d44c7
Put -c conda-forge in correct place
mcbarton Jan 20, 2025
466fbeb
Fix emsk install and activate commands
mcbarton Jan 20, 2025
8734152
Using emsdk from environment-wasm-build.yml file
mcbarton Jan 22, 2025
9e27b4c
Update PR based on comment
mcbarton Jan 22, 2025
8ea4937
Fix instructions
mcbarton Jan 22, 2025
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: 5 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,11 @@ git clone https://github.com/<your-github-username>/xeus-cpp.git
cd ./xeus-cpp
```

You'll now want to make sure you're using emsdk version "3.1.45" and activate it. You can get this by executing the following
You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing
the following
```bash
cd $HOME
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install 3.1.45
./emsdk activate 3.1.45
source $HOME/emsdk/emsdk_env.sh
micromamba create -f environment-wasm-build.yml -y
micromamba activate xeus-cpp-wasm-build
```

You are now in a position to build the xeus-cpp kernel. You build it by executing the following
Expand All @@ -98,7 +95,7 @@ emmake make install

To build Jupyter Lite with this kernel without creating a website you can execute the following
```bash
micromamba create -n xeus-lite-host jupyterlite-core
micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX
Expand Down
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,11 @@ git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
cd ./xeus-cpp
```

You'll now want to make sure you're using emsdk version "3.1.45" and activate it. You can get this by executing the following
You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing
the following
```bash
cd $HOME
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install 3.1.45
./emsdk activate 3.1.45
source $HOME/emsdk/emsdk_env.sh
micromamba create -f environment-wasm-build.yml -y
micromamba activate xeus-cpp-wasm-build
```

You are now in a position to build the xeus-cpp kernel. You build it by executing the following
Expand All @@ -99,7 +96,7 @@ emmake make install

To build Jupyter Lite with this kernel without creating a website you can execute the following
```bash
micromamba create -n xeus-lite-host jupyterlite-core
micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX
Expand Down
13 changes: 5 additions & 8 deletions docs/source/InstallationAndUsage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,14 @@ These instructions will assume you have cmake installed on your system. First cl
cd ./xeus-cpp


You'll now want to make sure you're using emsdk version "3.1.45" and activate it. You can get this by executing the following
You'll now want to make sure you are using the same emsdk as the rest of our dependencies. This can be achieved by executing
the following

.. code-block:: bash

cd $HOME
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install 3.1.45
./emsdk activate 3.1.45
source $HOME/emsdk/emsdk_env.sh

micromamba create -f environment-wasm-build.yml -y
micromamba activate xeus-cpp-wasm-build

You are now in a position to build the xeus-cpp kernel. You build it by executing the following

Expand All @@ -88,7 +85,7 @@ To build Jupyter Lite with this kernel without creating a website you can execut

.. code-block:: bash

micromamba create -n xeus-lite-host jupyterlite-core
micromamba create -n xeus-lite-host jupyterlite-core -c conda-forge
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX
Expand Down
Loading