From e9ccb32900cef2cd10f0a87771d8958c5eb49d9a Mon Sep 17 00:00:00 2001
From: florian <f.spreckelsen@inidscale.com>
Date: Wed, 7 Jul 2021 10:55:54 +0200
Subject: [PATCH] DOC: Explain installation of prerequisites

---
 README_SETUP.md | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/README_SETUP.md b/README_SETUP.md
index 7bc0e27..dc9d9b0 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -1,4 +1,24 @@
 # Set-up caosdb-julialib
 
-**TODO**: Explain installation (with Pkg.jl), running tests, dependencies,
-etc.
+The setup of this package consists of first compiling the c++ wrapper
+classes in `jlcaosdb` and then installing the Julia package
+`CaosDB.jl` itself. Hopefully, the process can be simplified by
+providing binary JLL packages in the future.
+
+## Prerequisites
+
+1. Build
+   [lbicxxwrap-julia](https://github.com/JuliaInterop/libcxxwrap-julia)
+   from source and install it to a location where it is found by cmake
+   later on by specifying a `CMAKE_INSTALL_PREFIX` (alternatively, add
+   this location to your `CMAKE_PREFIX_PATH`). You may have to create
+   an override as explained in the
+   [documentation](https://github.com/JuliaInterop/libcxxwrap-julia#using-the-compiled-libcxxwrap-julia-in-cxxwrap)
+   of libcxxwrap in order to use the compiled version and not theone
+   that is shipped with CxxWrap.jl.
+2. In the same way, build and install
+   [libcaosdb](https://gitlab.com/caosdb/caosdb-cpplib) in a way that
+   it is visible to cmake when compiling the wrapper classes later on.
+
+**TODO**: Explain installation (with Pkg.jl), running tests,
+dependencies, etc.
-- 
GitLab