Skip to content

Commit 659e968

Browse files
mcbartonvgvassilev
authored andcommitted
Fix build instructions
1 parent 0bffa06 commit 659e968

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,17 @@ mkdir build
4242
cd build
4343
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
4444
make check-xeus-cpp
45+
make install
4546
```
4647

4748
and
4849

4950
```bash
50-
cd ../../test
51+
cd ../test
5152
pytest -sv test_xcpp_kernel.py
5253
```
5354

54-
to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing
55-
56-
```bash
57-
make install
58-
```
55+
to perform the python tests.
5956

6057
## Setting up a development environment (wasm instructions)
6158

@@ -99,9 +96,10 @@ emmake make check-xeus-cpp
9996
emmake make install
10097
```
10198

102-
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
99+
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
103100

104101
```bash
102+
cd test
105103
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
106104
hdiutil attach Firefox-latest.dmg
107105
cp -r /Volumes/Firefox/Firefox.app $PWD
@@ -132,9 +130,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse
132130
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html
133131
```
134132

135-
To do this on Ubuntu x86 execute the following
133+
To run the browser tests on Ubuntu x86 execute the following from the build folder
136134

137135
```bash
136+
cd test
138137
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
139138
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
140139
cd ./chrome/opt/google/chrome/

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,14 @@ mkdir build
6363
cd build
6464
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
6565
make check-xeus-cpp
66+
make install
6667
```
6768
and
6869
```bash
69-
cd ../../test
70+
cd ../test
7071
pytest -sv test_xcpp_kernel.py
7172
```
72-
to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing
73-
74-
```bash
75-
make install
73+
to perform the python tests.
7674
```
7775
7876
## Installation within a mamba environment (wasm build instructions)
@@ -114,9 +112,10 @@ emmake make check-xeus-cpp
114112
emmake make install
115113
```
116114

117-
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
115+
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
118116

119117
```bash
118+
cd test
120119
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
121120
hdiutil attach Firefox-latest.dmg
122121
cp -r /Volumes/Firefox/Firefox.app $PWD
@@ -147,9 +146,10 @@ python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browse
147146
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html
148147
```
149148

150-
To do this on Ubuntu x86 execute the following
149+
To run the browser tests on Ubuntu x86 execute the following from the build folder
151150

152151
```bash
152+
cd test
153153
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
154154
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
155155
cd ./chrome/opt/google/chrome/

docs/source/InstallationAndUsage.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,17 @@ executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be)
3434
cd build
3535
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
3636
make check-xeus-cpp
37+
make install
3738
3839
and
3940

4041
.. code-block:: bash
4142
42-
cd ../../test
43+
cd ../test
4344
pytest -sv test_xcpp_kernel.py
4445
45-
to perform the python tests. After you have checked that the kernel passes all the tests, you can install it by executing
46-
47-
.. code-block:: bash
48-
49-
make install
46+
to perform the python tests.
47+
5048

5149
Installation within a mamba environment (wasm build instructions)
5250
========================
@@ -93,10 +91,11 @@ You are now in a position to build the xeus-cpp kernel. You build and test it in
9391
emmake make check-xeus-cpp
9492
emmake make install
9593
96-
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
94+
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
9795

9896
.. code-block:: bash
9997
98+
cd test
10099
wget "https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US" -O Firefox-latest.dmg
101100
hdiutil attach Firefox-latest.dmg
102101
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
126125
python $BUILD_PREFIX/bin/emrun.py --no_browser --kill_exit --timeout 60 --browser-args="--headless --no-sandbox" test_xeus_cpp.html &
127126
python ../../scripts/browser_tests_safari.py test_xeus_cpp.html
128127
129-
To do this on Ubuntu x86 execute the following
128+
To run the browser tests on Ubuntu x86 execute the following from the build folder
130129

131130
.. code-block:: bash
132131
132+
cd test
133133
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
134134
dpkg-deb -x google-chrome-stable_current_amd64.deb $PWD/chrome
135135
cd ./chrome/opt/google/chrome/

0 commit comments

Comments
 (0)