libqtxdg-packaging/README.md
Alf Gaida 3c96bc717b Cherry-picked new upstream release 2.0.0.
* Added current signing key
* Bumped compat to 10
* Bumped debhelper to (>= 10)
* Added build dependency libqt5svg5-dev
* Renamed package libqt5xdg1 -> libqt5xdg2 (soname bump)
* Added packages libqt5xdgiconloader2 and libqt5xdgiconloader-dev
* XdgIconLoader: Recommend gtk-update-icon-cache
  Thanks Rohan Garg <rohan@kde.org>
* Renamed install and symbols files
* Fixed symbols
* Fixed .gitignore
* Reworked descriptions in debian/control to prevent lintian whining
* Fixed copyright for xdgiconloader
* Added README.md to debian/docs
* Set CMAKE_BUILD_TYPE=RelWithDebInfo
2016-10-18 00:35:34 +02:00

28 lines
1.3 KiB
Markdown

# libqtxdg
## Overview
`libqtxdg` is a Qt 5 implementation of freedesktop.org XDG specifications.
It is maintained by the LXQt project and nearly all LXQt components are depending on it. Yet it can be used independently from this desktop environment, too.
The library is able to use GTK+ icon theme caches for faster icon lookup. The cache file can be generated with utility `gtk-update-icon-cache` on a theme directory. If the cache is not present, corrupted, or outdated, the normal slow lookup is still run.
## Installation
### Sources
At runtime qtbase is needed. gtk-update-icon-cache represents an optional runtime dependency for the reasons stated above.
Additional build dependencies are CMake, qtsvg, qttools and optionally Git to pull latest VCS checkouts.
The code configuration is handled by CMake so all corresponding generic instructions apply. Specific CMake variables are
* BUILD_TESTS to build tests. Disabled by default (`OFF`).
* BUILD_DEV_UTILS which builds and installs development utils. Disabled by default as well.
To build and install run `make` and `make install`respectively.
### Binary packages
The library is provided by all major Linux distributions like Arch Linux, Debian, Fedora and openSUSE.
Just use the distributions' package managers to search for string `libqtxdg`.