From 761a431d3d9774f12848d2c63e875523f3ededdf Mon Sep 17 00:00:00 2001
From: Christian Mollekopf <chrigi_1@fastmail.fm>
Date: Mon, 19 Feb 2018 17:38:16 +0100
Subject: Add development setup instructions

Summary:
Add some development setup instructions for manual install and using docker.

The docker instructions might need reviewing as I haven't been able to make it work myself.

Reviewers: cmollekopf

Reviewed By: cmollekopf

Tags: #kube

Differential Revision: https://phabricator.kde.org/D10655
---
 docs/setting-up-dev-env.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml                 |  1 +
 2 files changed, 44 insertions(+)
 create mode 100644 docs/setting-up-dev-env.md

diff --git a/docs/setting-up-dev-env.md b/docs/setting-up-dev-env.md
new file mode 100644
index 00000000..82d823bf
--- /dev/null
+++ b/docs/setting-up-dev-env.md
@@ -0,0 +1,43 @@
+# Setting up the development environment
+
+Multiple choices are available for developing the Kube project:
+
+- Manually
+- Docker
+
+## Manually
+
+- If sink is not in you repositories:
+    - Install the dependencies of Sink:
+        - extra-cmake-modules
+        - qt5-qtbase-devel / qtbase5-dev
+        - libgit2-dev(el)
+        - lmdb-devel / liblmdb-dev
+        - readline-devel / libreadline-dev
+        - libcurl-dev(el)
+        - kf5-kimap
+        - kf5-kimap-devel
+        - [KAsync](https://github.com/KDE/kasync/releases)
+    - Install Sink
+- Install the Kube project:
+    - `mkdir build && cd build && cmake .. && make && sudo make install`
+
+If you did not install sink in the `/usr` directory, you might need to set the
+`QT_PLUGIN_PATH` variable to something like this:
+`$SINK_INSTALL_PREFIX/lib/plugins`.
+
+In the same way, if did not install Kube in the `/usr` directory, you might
+need to set the `QML2_IMPORT_PATH` to something like this:
+`$KUBE_INSTALL_PREFIX/lib/qml/`.
+
+## Docker
+
+- Go to the `docker` directory
+- In the `run.sh` script, set the SOURCEDIR, BUILDDIR and INSTALLDIR variables
+  to an existing path containing respectively the source, build and
+  installation directory of kube. The build and installation directory can be
+  empty at first.
+- Run the `./build.sh` script
+- Run the `./run.sh` script
+- In the now opened container shell, run `cmake -DCMAKE_INSTALL_PREFIX=/install /src`
+- Run `make install`
diff --git a/mkdocs.yml b/mkdocs.yml
index 446c3397..c2feac92 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -5,4 +5,5 @@ pages:
 - Design: design.md
 - Requirements: requirements.md
 - Cryptography: cryptography.md
+- Dev environment setup: setting-up-dev-env.md
 theme: readthedocs
-- 
cgit v1.2.3