From a853b73370ad2ced884bdc3b5b6ae7f7f1fd677b Mon Sep 17 00:00:00 2001
From: Johan Mabille <johan.mabille@gmail.com>
Date: Tue, 11 Jun 2024 17:49:15 +0200
Subject: [PATCH] Updated build instructions in the README

---
 README.md | 26 ++++++++++----------------
 1 file changed, 10 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 10a9db0..3c476da 100644
--- a/README.md
+++ b/README.md
@@ -4,25 +4,12 @@
 
 ZeroMQ-based middleware for xeus integrated in the Qt event loop.
 
-## Dependencies
-
-| `xeus-qt` | `xeus-zmq` | `qt` | `nlohmann_json` |
-|-----------|------------|------|-----------------|
-|   main    |  ^3.0      | ^5.0 | ^3.11.3         |
-
-Versions prior to 0.2 also depend on `cppzmq` and `xtl`:
-
-| `xeus-qt` | `xeus` | `xeus-zmq` | `qt` | `xtl` | `cppzmq` | `nlohmann_json` |
-|-----------|--------|------------|------|-------|----------|-----------------|
-|  0.1.3    | ^3.0.0 | ^1.0       | ^5.0 |  ^0.7 | ^4.8.1   | ^3.2            |
-|  0.1.2    | ^3.0.0 | ^1.0       | ^5.0 |  ^0.7 | ^4.8.1   | ^3.2            |
-|  0.1.1    | ^3.0.0 | ^1.0       | ^5.0 |  ^0.7 | ^4.8.1   | ^3.2            |
-|  0.1.0    | ^3.0.0 | ^1.0       | ^5.0 |  ^0.7 | ^4.8.1   | ^3.2            |
-
 ## Building and running the example kernel from source
 
+First, create the environment with all required dependencies:
 ```
-mamba install compilers cmake nlohmann_json qt xeus-zmq xeus-lua xwidgets xcanvas -c conda-forge
+mamba env create -f environment-dev.yml -n xeus-qt
+mamba activate xeus-qt
 ```
 
 To build the main library:
@@ -42,6 +29,13 @@ cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX
 make install
 ```
 
+On linux, the build may fail with the following error:
+```
+cannot find "GL/gl.h"
+```
+
+In that case, run `mamba install mesalib -c conda-forge` and build again.
+
 # License
 
 We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.