Skip to content

Commit a853b73

Browse files
committed
Updated build instructions in the README
1 parent c8cb61b commit a853b73

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,12 @@
44

55
ZeroMQ-based middleware for xeus integrated in the Qt event loop.
66

7-
## Dependencies
8-
9-
| `xeus-qt` | `xeus-zmq` | `qt` | `nlohmann_json` |
10-
|-----------|------------|------|-----------------|
11-
| main | ^3.0 | ^5.0 | ^3.11.3 |
12-
13-
Versions prior to 0.2 also depend on `cppzmq` and `xtl`:
14-
15-
| `xeus-qt` | `xeus` | `xeus-zmq` | `qt` | `xtl` | `cppzmq` | `nlohmann_json` |
16-
|-----------|--------|------------|------|-------|----------|-----------------|
17-
| 0.1.3 | ^3.0.0 | ^1.0 | ^5.0 | ^0.7 | ^4.8.1 | ^3.2 |
18-
| 0.1.2 | ^3.0.0 | ^1.0 | ^5.0 | ^0.7 | ^4.8.1 | ^3.2 |
19-
| 0.1.1 | ^3.0.0 | ^1.0 | ^5.0 | ^0.7 | ^4.8.1 | ^3.2 |
20-
| 0.1.0 | ^3.0.0 | ^1.0 | ^5.0 | ^0.7 | ^4.8.1 | ^3.2 |
21-
227
## Building and running the example kernel from source
238

9+
First, create the environment with all required dependencies:
2410
```
25-
mamba install compilers cmake nlohmann_json qt xeus-zmq xeus-lua xwidgets xcanvas -c conda-forge
11+
mamba env create -f environment-dev.yml -n xeus-qt
12+
mamba activate xeus-qt
2613
```
2714

2815
To build the main library:
@@ -42,6 +29,13 @@ cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX
4229
make install
4330
```
4431

32+
On linux, the build may fail with the following error:
33+
```
34+
cannot find "GL/gl.h"
35+
```
36+
37+
In that case, run `mamba install mesalib -c conda-forge` and build again.
38+
4539
# License
4640

4741
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

0 commit comments

Comments
 (0)