*******************
*   Compilation   *
*******************
----------
IF YOU HAVE Arch OR ONE OF ITS DERIVATIVES, YOU COULD EASILY INSTALL Kvantum FROM ITS OFFICIAL REPOSITORY:

	sudo pacman -S kvantum-qt5

OR, PREFERABLY, YOU COULD INSTALL THE LATEST git PACKAGE FROM THE Arch-User-Repository BY USING THE AUR HELPER OF YOUR CHOICE, FOR EXAMPLE:

	yaourt -S kvantum-qt5-git
----------

First install X11 and Qt development packages. In Debian-based systems, they are:

 * g++
 * libx11-dev and libxext-dev (for X11)
 * qtbase5-dev, libqt5svg5-dev and libqt5x11extras5-dev (for Qt5)
 * libkf5windowsystem-dev (required with Qt >= 5.11)
 * qttools5-dev-tools (for localization if you need it)

In Arch-based systems, the packages are:

 * gcc (or gcc-multilib for multilib systems)
 * libx11 and libxext (for X11)
 * qt5-base, qt5-svg and qt5-x11extras (for Qt5)
 * kwindowsystem (required with Qt >= 5.11)
 * qt5-tools (for localization if you need it)

In Red Hat based systems like Fedora:

 * gcc-c++
 * libX11-devel
 * libXext-devel
 * qt5-qtx11extras-devel
 * qt5-qtbase-devel
 * qt5-qtsvg-devel
 * qt5-qttools-devel
 * kf5-kwindowsystem-devel (required with Qt >= 5.11)

And, finally, in OpenSUSE:

 * gcc-c++
 * libX11-devel
 * libXext-devel
 * libqt5-qtx11extras-devel
 * libqt5-qtbase-devel
 * libqt5-qtsvg-devel
 * libqt5-qttools-devel
 * kwindowsystem-devel (required with Qt >= 5.11)
----------
Tumbleweed users can also install Kvantum in this way (thanks to trmdi at GitHub):

	sudo zypper ar obs://home:trmdi trmdi
	sudo zypper in -r trmdi kvantum

----------

There are two ways to compile Kvantum: with qmake or with cmake.

With qmake
==========
Just open a terminal inside this folder and issue the following command:

	qmake && make

With some distros, you might need to put the full path of qmake in the above command.

With cmake
==========
Open a terminal inside this folder and issue the following commands:

	mkdir build && cd build
	cmake ..
	make

If you want to install Kvantum in a nonstandard path (which is not recommended), you could add the option "-DCMAKE_INSTALL_PREFIX=YOUR_SELECTED_PATH" to the cmake command.

********************
*   Installation   *
********************

Then, use this command for installation:

	sudo make install

If you have compiled Kvantum with qmake, the following command cleans the source completely and makes it ready for another compilation:

	make distclean

If you have used cmake for compilation, to compile Kvantum again, first remove the contents of the build directory.

The main reason for including a cmake build was that a few distros (especially Fedora) had problem with qmake.

*************
*   Usage   *
*************

In KDE:
=======
(1) Select Kvantum from 'System Settings > Application Style > Widget Style' and apply it.

(2) Select Kvantum from 'System Settings > Color > Scheme' and click Apply. You could change the color scheme later if you choose another Kvantum theme with Kvantum Manager (see "Using Other Themes" below).

Logging out and in would be good for Plasma to see the new theme.

In LXQt:
========
Just select "kvantum" from Configuration Center > Widget Style. Kvantum Manager is also shown in Configuration Center for changing the Kvantum theme.

In case you use Compton as the X compositor (not recommended), be sure to disable Compton's shadow and blurring for composited Qt menus with lines like these in '~/.config/compton.conf':

shadow-exclude = [ "argb && (_NET_WM_WINDOW_TYPE@:a *= 'MENU' || _NET_WM_WINDOW_TYPE@:a *= 'COMBO')" ];
blur-background-exclude = [ "(_NET_WM_WINDOW_TYPE@:a *= 'MENU' || _NET_WM_WINDOW_TYPE@:a *= 'COMBO')" ];

In Other DEs:
=============
In desktop environments that do not have a Qt5 configuration utility, you could use this command to run a Qt5 application APP:

	APP -style kvantum

Or, better, set the environment variable "QT_STYLE_OVERRIDE" to "kvantum". For example, you could add this line to your '~/.profile' or '~/.bashrc':

	export QT_STYLE_OVERRIDE=kvantum

If the display manager you use does not source '~/.profile', you could probably add the above line to '~/.xsessionrc'. The last resort is `/etc/environment` but most desktop environments have GUI tools for setting environment variables.

**************************
*   Using Other Themes   *
**************************

To select or install (as user) Kvantum themes, use "Kvantum Manager", which is already installed and is available in the start menu as a utility app. It explains each step in a straightforward way. With it, you could not only switch between themes easily but also select themes for specific applications.

For the running parts of KDE/LXQt to recognize the new Kvantum theme, the easiest way is logging out and in again.

*****************************
*   Notes for Theme Makers  *
*****************************

If the KDE color scheme of the theme is inside its folder, "Kvantum Manager" will install it too. So, theme makers might want to put these files in their theme folder: $THEME_NAME.svg, $THEME_NAME.kvconfig and $THEME_NAME.colors.

The contents of theme folders (if valid) can also be installed manually in the user's home. The possible installation paths are '~/.config/Kvantum/$THEME_NAME/', '~/.themes/$THEME_NAME/Kvantum/' and '~/.local/share/themes/$THEME_NAME/Kvantum/', each one of which takes priority over the next one, i.e. if a theme is installed in more than one path, only the instance with the highest priority will be used by Kvantum.

Themes can also be packaged as deb, rpm, xz,... packages and installed as root:
	(1) The possible root installation paths are '/usr/share/Kvantum/$THEME_NAME/' and '/usr/share/themes/$THEME_NAME/Kvantum/' (if PREFIX=/usr). The first path will take priority over the second one if a theme is installed in both.
	(2) The KDE color schemes should go to  '/usr/share/color-schemes/' for KF5 and '/usr/share/kde4/apps/color-schemes/' for KDE4.
	(3) If a theme is installed both as root and as user, the latter installation will take priority.

Please see "Theme-Making.pdf" for more information on theme installation paths and their priorities.

The default Qt5 installation adds several root themes, that can be selected by using Kvantum Manager. Their corresponding KDE color schemes are also installed.

***********
*   GTK   *
***********

Kvantum does not -- and will not -- have any relation to GTK. However, it includes some themes similar to or matching GTK themes.
