diff options
| author | Christian Mollekopf <chrigi_1@fastmail.fm> | 2018-03-20 11:21:00 +0100 |
|---|---|---|
| committer | Christian Mollekopf <chrigi_1@fastmail.fm> | 2018-03-20 11:21:00 +0100 |
| commit | 373cb190e185cd86c1cb6279066d8d778edf2359 (patch) | |
| tree | 70f5619d783091d1d7764fb0a7205240c54d3802 /docs | |
| parent | d3fbc5557ed8bd495e9a5d2e1fd5aff48a1589b3 (diff) | |
| download | kube-373cb190e185cd86c1cb6279066d8d778edf2359.tar.gz kube-373cb190e185cd86c1cb6279066d8d778edf2359.zip | |
Updated docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/setting-up-dev-env.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/setting-up-dev-env.md b/docs/setting-up-dev-env.md index 82d823bf..9fc63bb3 100644 --- a/docs/setting-up-dev-env.md +++ b/docs/setting-up-dev-env.md | |||
| @@ -15,9 +15,10 @@ Multiple choices are available for developing the Kube project: | |||
| 15 | - lmdb-devel / liblmdb-dev | 15 | - lmdb-devel / liblmdb-dev |
| 16 | - readline-devel / libreadline-dev | 16 | - readline-devel / libreadline-dev |
| 17 | - libcurl-dev(el) | 17 | - libcurl-dev(el) |
| 18 | - kf5-kimap | 18 | - flatbuffers-dev |
| 19 | - kf5-kimap-devel | 19 | - [KAsync](git://anongit.kde.org/kasync) |
| 20 | - [KAsync](https://github.com/KDE/kasync/releases) | 20 | - [KDAV2](git://anongit.kde.org/kdav2) |
| 21 | - [KIMAP2](git://anongit.kde.org/kimap2) | ||
| 21 | - Install Sink | 22 | - Install Sink |
| 22 | - Install the Kube project: | 23 | - Install the Kube project: |
| 23 | - `mkdir build && cd build && cmake .. && make && sudo make install` | 24 | - `mkdir build && cd build && cmake .. && make && sudo make install` |
| @@ -31,13 +32,18 @@ need to set the `QML2_IMPORT_PATH` to something like this: | |||
| 31 | `$KUBE_INSTALL_PREFIX/lib/qml/`. | 32 | `$KUBE_INSTALL_PREFIX/lib/qml/`. |
| 32 | 33 | ||
| 33 | ## Docker | 34 | ## Docker |
| 35 | Building kube in a docker containers ensures reproducability and decouples the development environment from the host system (so upgrading your host system doesn't break all your builds). To avoid having to develop inside the container directly, source, build and install directories reside on the host system. | ||
| 34 | 36 | ||
| 35 | - Go to the `docker` directory | 37 | - Go to the `docker` directory |
| 36 | - In the `run.sh` script, set the SOURCEDIR, BUILDDIR and INSTALLDIR variables | 38 | - In the `run.sh` script, set the SOURCEDIR, BUILDDIR and INSTALLDIR variables |
| 37 | to an existing path containing respectively the source, build and | 39 | to an existing path containing respectively the source, build and |
| 38 | installation directory of kube. The build and installation directory can be | 40 | installation directory of kube. The build and installation directory should be |
| 39 | empty at first. | 41 | empty at first, for the source directory you may use an existing directory containing the necessary source directories. |
| 40 | - Run the `./build.sh` script | 42 | - Run the `./build.sh` script |
| 41 | - Run the `./run.sh` script | 43 | - Run the `./run.sh` script |
| 42 | - In the now opened container shell, run `cmake -DCMAKE_INSTALL_PREFIX=/install /src` | 44 | - If you don't have the sources available yet, run the `~/initrepositories.sh` script |
| 43 | - Run `make install` | 45 | - To configure the build directories, for each repository: |
| 46 | - `mkdir /build/$REPO && cd /build/$REPO` | ||
| 47 | - `cmake -DCMAKE_INSTALL_PREFIX=/install /src/$REPO` | ||
| 48 | - `make && make install` | ||
| 49 | - You can now edit the sources outside the container, and build and run kube inside the container. | ||