Warning, /pim/kdepim-docker/README.md is written in an unsupported language. File is not indexed.

0001 # KDE PIM Docker for developers
0002 
0003 This repository contains Dockerfile to create a Docker image for developing
0004 KDE PIM. The image is based on KDE Neon Developer edition and has all the
0005 dependencies needed to compile KDE PIM from source code and run Akonadi and
0006 Kontact inside the container.
0007 
0008 You can find more details about this Docker image and how to use it on our
0009 [Docker wiki page on community.kde.org](https://community.kde.org/KDE_PIM/Docker).
0010 
0011 ## Building Docker image
0012 
0013 Please check our [wiki page](https://community.kde.org/KDE_PIM/Docker) first
0014 regarding using different GPU drivers.
0015 
0016 In order to build the Docker image, run the `build.sh` script. If you are
0017 using proprietary NVIDIA drivers, run the script with `-n` switch.
0018 
0019 The command will create kdepim:dev Docker image.
0020 
0021 ## Running Docker container
0022 
0023 The first time you should create a directory on your host system where you
0024 want to have the KDE PIM sources, build and runtime directories etc. stored.
0025 
0026 To run the container, use the `run.sh` script:
0027 
0028 `run.sh /path/to/the/directory`
0029 
0030 If you are using proprietary NVIDIA drivers, run the script with `-n` switch:
0031 
0032 `run.sh -n /path/to/the/directory`
0033 
0034 The content of the directory will be available in the container in the
0035 /home/neon/kdepim directory.
0036 
0037 ## Building and updating KDE PIM
0038 
0039 Once inside the container, you can use the following command to compile the
0040 entire KDE PIM:
0041 
0042 `kdesrc-build kde-pim`
0043 
0044 This will take a lot of time the first time, but all subsequent builds will be
0045 faster thanks to ccache. You can also build just a single project by passing a
0046 specific repository name instead of the `kde-pim` group to kdesrc-build.
0047 
0048 Check the [kdesrc-build documentation](https://kdesrc-build.kde.org) for more
0049 details about kdesrc-build.
0050 
0051 kdesrc-build will clone all the repositories into /home/neon/kdepim/src/kde/pim,
0052 build directories (where you can run `make` manually are in /home/neon/kdepim/build/kde/pim.
0053 The binaries are installed into /home/neon/kdepim/install (and the environment
0054 of the container is adjusted to work with this installation prefix).
0055 
0056 ## Development tools
0057 
0058 There's [KDevelop](https://www.kdevelop.org) and [QtCreator](https://www.qt.io/ide/)
0059 preinstalled in the container and you can run them from there. You can also use
0060 them from outside of the container, but code completion might not work perfectly.
0061 
0062 You can also any other IDE of your choice either by installing it into the container
0063 with apt-get, or use it from outside of the container.
0064 
0065 ## Contributing
0066 
0067 Please send pull requests to [invent.kde.org](https://invent.kde.org).
0068 
0069 ## Contact
0070 
0071 If you have any questions regarding contributing to KDE PIM or this Docker image,
0072 feel free to contact us on the KDE PIM mailing list (kde-pim@kde.org) or on the
0073 #kontact IRC channel on Freenode.