Skip to content

Commit d9b5203

Browse files
authored
Update README.md installation instructions (#33)
1 parent f2c743e commit d9b5203

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

README.md

+12-22
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
`xeus-cpp` is a Jupyter kernel for cpp based on the native implementation of the
99
Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).
1010

11-
## Installation
11+
## Installation within a mamba envirnoment
1212

1313
xeus-cpp has not been packaged for the mamba (or conda) package manager.
1414

@@ -19,32 +19,22 @@ fresh environment. It is also needed to use a
1919
[anaconda](https://www.anaconda.com/) you may have a conflict with the `zeromq` library
2020
which is already installed in the anaconda distribution.
2121

22-
The safest usage is to create an environment named `xeus-cpp`
23-
22+
First clone the repository, and move into that directory
2423
```bash
25-
mamba create -n `xeus-cpp`
26-
source activate `xeus-cpp`
24+
git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
25+
cd ./xeus-cpp
2726
```
28-
29-
<!-- ### Installing from conda-forge
30-
31-
Then you can install in this environment `xeus-cpp` and its dependencies
32-
27+
The safest usage of xeus-cpp is to build and install it within a clean environment named `xeus-cpp`. You can create and activate this environment
28+
with mamba by executing the following
3329
```bash
34-
mamba install`xeus-cpp` notebook -c conda-forge
35-
``` -->
36-
37-
### Installing from source
38-
39-
Or you can install it from the sources, you will first need to install dependencies
40-
30+
mamba create -n "xeus-cpp"
31+
source activate "xeus-cpp"
32+
```
33+
We will now install the dependencies needed to compile xeux-cpp from source within this environment by executing the following
4134
```bash
42-
mamba install cmake cxx-compiler xeus-zmq nlohmann_json cppzmq xtl jupyterlab clangdev=16 cpp-argparse pugixml -c conda-forge
35+
mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json cppzmq xtl jupyterlab clangdev=16 cpp-argparse pugixml doctest -c conda-forge
4336
```
44-
45-
Then you can compile the sources (replace `$CONDA_PREFIX` with a custom installation
46-
prefix if need be)
47-
37+
Now you can compile the kernel from the source by executing (replace `$CONDA_PREFIX` with a custom installation prefix if need be)
4838
```bash
4939
mkdir build && cd build
5040
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib

0 commit comments

Comments
 (0)