Skip to content

README.md

Latest commit

 

History

History
60 lines (39 loc) · 1.62 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.62 KB

Union

Union is a style engine designed to provide a unified style description to a set of separate output styles.

Getting Started

To use Union in your Kirigami application, ensure it is installed and then use QT_QUICK_CONTROLS_STYLE=org.kde.union or equivalent in code.

To learn more about how to use or develop Union, see the Union Documentation.

Note that currently there is no documentation about developing styles for Union. This is due to there being only one input format plugin that uses KDE Plasma's SVG styling.

Building

To build Union, you will need a recent version of CMake and Qt version 6.8 or higher. To build the Plasma SVG input plugin, you will additionally need RapidYAML version 0.6 or higher.

You can build and install Union manually with CMake like this:

cmake -B build/ --install-prefix /usr
cmake --build build/ --parallel
sudo cmake --install build/

Or with kde-builder:

kde-builder union

To allow building the code examples, use:

cmake -B build --install-prefix /usr -DBUILD_EXAMPLES=ON

Or:

kde-builder union
kde-builder union --no-include-dependencies --cmake-options=-DBUILD_EXAMPLES=ON

Get Involved

You may contact the Union developers in the Union room on Matrix.