Add Traditional Chinese desktop entry
[lxde/compton-conf.git] / README.md
CommitLineData
1dda9b66 1# compton-conf
2
c6d6efbe
PM
3## Overview
4
5compton-conf is a configuration tool for X composite manager [Compton](https://github.com/chjj/compton).
1dda9b66 6
7![Screenshot of compton-conf running on awesome-wm](http://i.imgur.com/2fSiAx8.png)
8
c6d6efbe
PM
9It is maintained by the LXQt project but can be used independently from this desktop environment.
10
11## Installation
12
13### Compiling source code
14
15Runtime dependencies are libconfig and qtbase.
16Additional build dependencies are CMake and [liblxqt](https://github.com/lxde/liblxqt) as well as optionally Git to pull latest VCS checkouts. The localization files were outsourced to repository [lxqt-l10n](https://github.com/lxde/lxqt-l10n) so the corresponding dependencies are needed, too. Please refer to this repository's `README.md` for further information.
17
18Code configuration is handled by CMake. CMake variable `CMAKE_INSTALL_PREFIX` has to be set to `/usr` on most operating systems.
19
20To build run `make`, to install `make install` which accepts variable `DESTDIR` as usual.
21
22### Binary packages
23
24Official binary packages are available in Arch Linux, Debian (as of Debian stretch) and openSUSE (Leap 42.1 and Tumbleweed).
25The tool is missing in Fedora so far.