2.1. Installation and initial configuration

2.1.1. Initial Setup of KDE Builder

2.1.1.1. Install KDE Builder

Before installing, configure your PATH environment variable to include the ~/.local/bin path - the location where kde-builder will be installed. See how to set environment variables for more information.

For example, add this code to your ~/.bashrc or ~/.zshrc:

export PATH="$HOME/.local/bin:$PATH"

or, if using fish shell, you can add it by running (this stays permanent):

fish_add_path ~/.local/bin

Note

On Debian-like distros, the default ~/.profile automatically adds ~/.local/bin to PATH when ~/.local/bin exists. The initial_setup.sh script will automatically source the ~/.profile file, so you do not need to additionally configure PATH.

You can install KDE Builder with its installation script:

cd ~
curl 'https://invent.kde.org/sdk/kde-builder/-/raw/master/scripts/initial_setup.sh?ref_type=heads' > initial_setup.sh
bash initial_setup.sh

The installation script will prompt to install KDE Builder's runtime dependencies, and do installation itself.

You can update KDE Builder later by running this script again.

Note

If for some reason you want to make installation differently, consult Alternative Installation Methods.

2.1.1.2. Prepare the configuration file

KDE Builder uses a configuration file to control which projects are built, where they are installed to, etc.

Run this command to generate configuration file:

kde-builder --generate-config

The config file will be located at ~/.config/kde-builder.yaml (or $XDG_CONFIG_HOME/kde-builder.yaml, if $XDG_CONFIG_HOME is set).

You can then edit the ~/.config/kde-builder.yaml configuration file to make any changes you see fit.

2.1.1.3. Install the dependencies for projects

Building of projects requires some packages from your distribution to be installed.

Run this command to install needed dependencies:

kde-builder --install-distro-packages