Skip to content

Commit 238c7a8

Browse files
mcbartonvgvassilev
authored andcommitted
Update CONTRIBUTING.md to be consistent with ci
1 parent 792f9e9 commit 238c7a8

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,42 @@ minutes of past meetings can be found on our
1717

1818
## Setting up a development environment
1919

20-
First, you need to fork the project. Then setup your environment:
20+
First, you need to fork the project. After you have done this clone your forked repo. You can do this by
21+
executing the folowing
2122

2223
```bash
23-
# create a new conda environment
24-
conda env create -f environment-dev.yml
25-
conda activate xeus-cpp
26-
27-
# download xeus-cpp from your GitHub fork
2824
git clone https://github.com/<your-github-username>/xeus-cpp.git
2925
```
3026

31-
You may also want to install a C++ compiler, and cmake from conda if they are not
32-
available on your system.
27+
To ensure that the installation works, it is preferable to install xeus-cpp in a fresh environment. It is
28+
also needed to use a miniforge or miniconda installation because with the full anaconda you may have a
29+
conflict with the zeromq library which is already installed in the anaconda distribution. Once you have miniforge
30+
or miniconda installed cd into the xeus-cpp directory and set setup your environment:
31+
32+
```bash
33+
cd xeus-cpp
34+
micromamba create -n xeus-cpp environment-dev.yml
35+
micromamba activate xeus-cpp
36+
```
3337

34-
## Building and installing xeus-cpp
38+
You are now in a position to install xeus-cpp into this envirnoment. You can do this by executing
3539

3640
```bash
37-
# Create a directory for building
3841
mkdir build && cd build
39-
# Generate the makefile with cmake
4042
cmake -D CMAKE_BUILD_TYPE=Release -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib ..
41-
# Build and install
42-
make install -j2
43+
make install
4344
```
4445

45-
## Running the tests
46+
To check that everything is installed correctly you can run the c++ tests by executing the following
47+
48+
```bash
49+
cd ./test
50+
./test_xeus_cpp
51+
```
4652

47-
To run Python tests, from the build directory, type
53+
and the python tests by executing
4854

4955
```bash
50-
cd ../test
51-
pytest . -vvv
56+
cd ./test
57+
pytest -sv .
5258
```

0 commit comments

Comments
 (0)