README.md

Aurora Client

Qt-style API to interact with Wayland protocols inside Qt-based graphical applications.

Dependencies

Qt >= 5.15.0 with at least the following modules is required:

• qtbase
• qtwayland

The following modules and their dependencies are required:

• cmake >= 3.10.0
• cmake-shared >= 2.0.0
• wayland-protocols >= 1.15

Build-time only dependencies:

• aurora-scanner >= 0.0.0

Optional dependencies:

• qtdeclarative

Installation

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/prefix ..
make
make install # use sudo if necessary

Replace /path/to/prefix to your installation prefix. Default is /usr/local.

Logging categories

Qt 5.2 introduced logging categories and we take advantage of them to make debugging easier.

Please refer to the Qt documentation to learn how to enable them.

Available categories:

• aurora.client.wlrforeigntoplevelmanagementv1: Foreign toplevel management client extension.
• aurora.client.wlrlayershellv1: Layer shell client extension.
• aurora.client.wlrscreencopyv1: Screencopy client extension.
• aurora.client.lirishellv1: Shell client extension.

Licensing

Licensed under the terms of the GNU General Public License version 3 or, at your option, any later version.