From a9dc64f7d822b2ec9d7699a0d6064d634687aba9 Mon Sep 17 00:00:00 2001 From: mcbarton Date: Mon, 10 Nov 2025 19:05:57 +0000 Subject: [PATCH] Fix build instructions --- CONTRIBUTING.md | 15 +++++++-------- README.md | 14 +++++++------- docs/source/InstallationAndUsage.rst | 16 ++++++++-------- 3 files changed, 22 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f68b64b6..7185b7b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,20 +42,17 @@ mkdir build cd build cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib make check-xeus-cpp +make install ``` and ```bash -cd ../../test +cd ../test pytest -sv test_xcpp_kernel.py ``` -to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing - -```bash -make install -``` +to perform the python tests. ## Setting up a development environment (wasm instructions) @@ -99,9 +96,10 @@ emmake make check-xeus-cpp emmake make install ``` -It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following +It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder ```bash +cd test wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg hdiutil attach Firefox-latest.dmg cp -r /Volumes/Firefox/Firefox.app $PWD @@ -132,9 +130,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse python ../../scripts/browser_tests_safari.py test_xeus_cpp.html ``` -To do this on Ubuntu x86 execute the following +To run the browser tests on Ubuntu x86 execute the following from the build folder ```bash +cd test wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome cd ./chrome/opt/google/chrome/ diff --git a/README.md b/README.md index bff97d94..e7de09c1 100644 --- a/README.md +++ b/README.md @@ -63,16 +63,14 @@ mkdir build cd build cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib make check-xeus-cpp +make install ``` and ```bash -cd ../../test +cd ../test pytest -sv test_xcpp_kernel.py ``` -to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing - -```bash -make install +to perform the python tests. ``` ## Installation within a mamba environment (wasm build instructions) @@ -114,9 +112,10 @@ emmake make check-xeus-cpp emmake make install ``` -It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following +It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder ```bash +cd test wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg hdiutil attach Firefox-latest.dmg cp -r /Volumes/Firefox/Firefox.app $PWD @@ -147,9 +146,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse python ../../scripts/browser_tests_safari.py test_xeus_cpp.html ``` -To do this on Ubuntu x86 execute the following +To run the browser tests on Ubuntu x86 execute the following from the build folder ```bash +cd test wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome cd ./chrome/opt/google/chrome/ diff --git a/docs/source/InstallationAndUsage.rst b/docs/source/InstallationAndUsage.rst index 873a2eba..e3b95a25 100644 --- a/docs/source/InstallationAndUsage.rst +++ b/docs/source/InstallationAndUsage.rst @@ -34,19 +34,17 @@ executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be) cd build cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib make check-xeus-cpp + make install and .. code-block:: bash - cd ../../test + cd ../test pytest -sv test_xcpp_kernel.py -to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing - -.. code-block:: bash - - make install +to perform the python tests. + Installation within a mamba environment (wasm build instructions) ======================== @@ -93,10 +91,11 @@ You are now in a position to build the xeus-cpp kernel. You build and test it in emmake make check-xeus-cpp emmake make install -It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following +It is possible to run the Emscripten tests in a headless browser. We will run our tests in a fresh installed browser. Installing the browsers, and running the tests within the installed browsers will be platform dependent. To do this for Chrome and Firefox on MacOS execute the following from the build folder .. code-block:: bash + cd test wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg hdiutil attach Firefox-latest.dmg cp -r /Volumes/Firefox/Firefox.app $PWD @@ -126,10 +125,11 @@ python package. This only needs to be enable once, and then you can execute the python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browser-args="--headless --no-sandbox" test_xeus_cpp.html & python ../../scripts/browser_tests_safari.py test_xeus_cpp.html -To do this on Ubuntu x86 execute the following +To run the browser tests on Ubuntu x86 execute the following from the build folder .. code-block:: bash + cd test wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome cd ./chrome/opt/google/chrome/