Update README

README.md

@@ -1,3 +1,5 @@
+### Xeus-Clang-REPL
+
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/compiler-research/xeus-clang-repl/HEAD?labpath=notebooks/Python-Cpp-Integration-Demo.ipynb)
 
 ## Description
@@ -6,6 +8,66 @@
 
 `Disclaimer: this work is highly experimental and might not work beyond the examples provided`
 
+## Installation
+
+To ensure that the installation works, it is preferable to install `xeus-clang-repl` in a
+fresh environment. It is also needed to use a
+[miniforge](https://github.com/conda-forge/miniforge#mambaforge) or
+[miniconda](https://conda.io/miniconda.html) installation because with the full
+[anaconda](https://www.anaconda.com/) you may have a conflict with the zeromq library 
+
+You will first need to install dependencies
+
+```bash
+mamba install cmake cxx-compiler nlohmann_json cppzmq xtl jupyterlab clangdev=14 cxxopts pugixml -c conda-forge
+```
+
+**Note:** Use a mamba environment with python version >= 3.11 for fetching clang-versions
+
+The safest usage is to create an environment named `xeus-clang-repl`
+
+```bash
+mamba create -n  `xeus-clang-repl`
+source activate  `xeus-clang-repl`
+```
+
+<!-- ### Installing from conda-forge
+
+Then you can install in this environment `xeus-clang-repl` and its dependencies
+
+```bash
+mamba install`xeus-clang-repl` notebook -c conda-forge
+``` -->
+
+```bash
+git clone https://github.com/llvm/llvm-project
+
+git checkout -b release/15.0x
+
+git apply patches/llvm/clang15-D127284.patch
+
+mkdir build
+
+cd build
+
+cmake -DLLVM_ENABLE_PROJECTS=clang -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles" ../llvm
+
+make -j n
+
+cd ..
+
+git clone https://github.com/compiler-research/xeus-clang-repl.git
+
+mkdir build
+
+cd build
+
+cmake ../ -DClang_DIR=/usr/lib/llvm-15/build/lib/cmake/clang\
+         -DLLVM_DIR=/usr/lib/llvm-15/build/lib/cmake/llvm
+
+make -j n
+```
+
 ## Try it online
 
 To try out xeus-clang-repl interactively in your web browser, just click on the binder
@@ -19,3 +81,26 @@ link:
    alt="Alt text"
    title="Optional title"
    style="display: block; margin: 0 auto; max-width: 450px">
+
+## Documentation
+
+To get started with using `xeus-clang-repl`, The Documentation work is under Development.
+
+## Dependencies
+
+`xeus-clang-repl` depends on
+
+- [xtl](https://github.com/xtensor-stack/xtl)
+- [nlohmann_json](https://github.com/nlohmann/json)
+- [cppzmq](https://github.com/zeromq/cppzmq)
+- [clang](https://github.com/llvm/llvm-project/)
+- [cxxopts](https://github.com/jarro2783/cxxopts)
+
+|   `xeus-clang-repl`   |       `xtl`     |  `clang`  | `pugixml` | `cppzmq` | `cxxopts` | `nlohmann_json` | `dirent` (windows only) |
+|-----------------------|-----------------|-----------|-----------|----------|-----------|-----------------|-------------------------|
+|   	~0.1.0 		      |  >=0.7.0,<0.8.0 | >=16,<17  | ~1.8.1    | ~4.3.0   |  >=3.0.0  |  >=3.6.1,<4.0   |    >=2.3.2,<3           |
+
+## License
+
+This software is licensed under the `Apache License`. See the [LICENSE](LICENSE)
+file for details.