liri-archive / vibe

:book: QtQuick modules for shell and applications

Vibe

A collection of core classes used throughout Liri.

Features

This library includes:

• A QML plugin to access storage devices and batteries

Dependencies

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

• qtbase
• qtdeclarative

The following modules and their dependencies are required:

• qbs >= 1.9.0
• qbs-shared >= 1.2.0
• libliri
• solid

Installation

Qbs is a new build system that is much easier to use compared to qmake or CMake.

If you want to learn more, please read the Qbs manual, especially the setup guide and how to install artifacts from the installation guide.

If you haven't already, start by setting up a qt5 profile for qbs:

qbs setup-toolchains --type gcc /usr/bin/g++ gcc
qbs setup-qt $(which qmake) qt5 # make sure that qmake is in PATH
qbs config profiles.qt5.baseProfile gcc

Then, from the root of the repository, run:

qbs -d build -j $(nproc) profile:qt5 # use sudo if necessary

To the qbs call above you can append additional configuration parameters:

• modules.lirideployment.prefix:/path/to/prefix where most files are installed (default: /usr/local)
• modules.lirideployment.dataDir:path/to/lib where data files are installed (default: /usr/local/share)
• modules.lirideployment.libDir:path/to/lib where libraries are installed (default: /usr/local/lib)
• modules.lirideployment.qmlDir:path/to/qml where QML plugins are installed (default: /usr/local/lib/qml)
• modules.lirideployment.pluginsDir:path/to/plugins where Qt plugins are installed (default: /usr/local/lib/plugins)
• modules.lirideployment.qbsModulesDir:path/to/qbs where Qbs modules are installed (default: /usr/local/share/qbs/modules)

See lirideployment.qbs for more deployment-related parameters.

You can also specify the following options:

• projects.Vibe.useStaticAnalyzer:true to enable the Clang static analyzer

Notes

Logging categories

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

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

Available categories

• Hardware QML plugin:

  • vibe.hardware: Hardware service.
  • vibe.hardware.battery: Battery information.
  • vibe.hardware.storagedevice: Storage device information.

• Notifications QML plugin:

  • vibe.notifications: Notifications service.

• MPRIS2 QML plugin:

  • vibe.mpris2: MPRIS2 engine
  • vibe.mpris2.player: MPRIS2 player interface

• Network QML plugin:

  • vibe.networkmanager: NetworkManager support.

• PolicyKit QML plugin:

  • vibe.policykit: PolicyKit agent.

Licensing

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