Warning, /plasma-mobile/plasma-settings/README.md is written in an unsupported language. File is not indexed.

0001 # Plasma Settings
0002 
0003 Settings application for Plasma Mobile.
0004 
0005 ## Configuration modules
0006 
0007 Our aim for configuration modules is to work on multiple form factors.
0008 To archieve this, their user interface should be based on the new
0009 [KQuickAddons::ConfigModule API](https://api.kde.org/frameworks/kdeclarative/html/classKQuickAddons_1_1ConfigModule.html)
0010 and Kirigami.
0011 You can find documentation on creating such configuration modules on
0012 [docs.plasma-mobile.org/PlasmaSettings.html](https://docs.plasma-mobile.org/PlasmaSettings.html)
0013 
0014 Modules only useful on mobile can be added to the `modules` directory of this
0015 repository, but if they are useful for devices of multiple form factors,
0016 they should go into the plasma-workspace repository.
0017 
0018 ## Build and run from source
0019 
0020 This project uses `cmake` to find the dependencies and build the project.
0021 
0022 ```sh
0023 cmake -S . -B build -DCMAKE_INSTALL_PREFIX=${PWD}/install
0024 cmake --build build --target install -j4
0025 ```
0026 
0027 Defining the installation prefix (with `CMAKE_INSTALL_PREFIX`)
0028 generates a file in the build folder (`build/prefix.sh`) with
0029 environment variables for `plasma-settings` to find the freshly built modules.
0030 
0031 To run `plasma-settings` first source the environment variables and then start the binary.
0032 
0033 ```sh
0034 source build/prefix.sh
0035 ./install/bin/plasma-settings
0036 ```