Go to file
Yuxuan Shui 83c32e1dd6
Tweak the wording in man page
Make it clearer how command line options and config file options are related.

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-01-30 20:53:34 +00:00
.circleci Enable more build tests 2019-01-02 20:43:01 +00:00
.github Update issue template 2018-11-26 15:46:04 +00:00
LICENSES More license stuff... 2018-10-04 11:18:09 +01:00
bin Fix small misspellings 2019-01-28 10:58:14 +01:00
dbus-examples Update comments about clear-shadow 2018-09-24 00:20:28 +01:00
man Tweak the wording in man page 2019-01-30 20:53:34 +00:00
media Added 48x48px raster of initial Compton logo 2015-09-17 21:57:11 -04:00
src Improve config file search order 2019-01-30 00:27:14 +00:00
tests Remove cmake leftovers 2018-12-14 17:13:30 +00:00
.clang-format Check in .clang-format 2019-01-08 22:14:09 +00:00
.editorconfig Fix building with opengl, again 2018-12-16 02:48:02 +00:00
.gitignore Remove xrender-sync and xrender-sync-fence 2018-10-28 23:36:55 +00:00
CONTRIBUTORS Update CONTRIBUTORS 2018-12-22 00:15:09 +00:00
COPYING More license stuff... 2018-10-04 11:18:09 +01:00
Doxyfile Fix small misspellings 2019-01-28 10:58:14 +01:00
LICENSE.spdx More license stuff... 2018-10-04 11:18:09 +01:00
README.md Update README 2018-12-21 21:23:45 +00:00
README_orig.md update readme 2018-04-16 10:13:55 -04:00
compton-default-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb 2014-05-16 15:18:17 +08:00
compton-fake-transparency-fshader-win.glsl Feature: #183 custom window shader & #193 --no-fading-destroyed-argb 2014-05-16 15:18:17 +08:00
compton.desktop Set icon to `compton` in compton.desktop 2015-06-05 17:14:46 -05:00
compton.sample.conf Make --logpath work again 2018-12-21 22:59:21 +00:00
desc.txt Misc: #49: Add CMake support 2012-10-03 13:34:54 +08:00
functions.sh Misc: Move shared functions out of make-release.sh 2015-01-11 16:26:36 +08:00
make-release.sh Misc: Move shared functions out of make-release.sh 2015-01-11 16:26:36 +08:00
meson.build Improve the header includes, cont'd 2019-01-20 17:10:06 +00:00
meson_options.txt Fix small misspellings 2019-01-28 10:58:14 +01:00

README.md

Compton

This is a development branch, bug to be expected

This is forked from the original Compton because that seems to have become unmaintained.

The current battle plan of this fork is to refactor it to make the code possible to maintain, so potential contributors won't be scared away when they take a look at the code.

We also try to fix bugs.

The original README can be found here

Changelog

See Releases

Build

Dependencies

Assuming you already have all the usual building tools installed (e.g. gcc, meson, ninja, etc.), you still need:

  • libx11
  • libx11-xcb
  • libXext
  • xproto
  • xcb
  • xcb-damage
  • xcb-xfixes
  • xcb-shape
  • xcb-renderutil
  • xcb-render
  • xcb-randr
  • xcb-composite
  • xcb-image
  • xcb-present
  • xcb-xinerama (optional, disable with the -Dxinerama=false meson configure flag)
  • pixman
  • libdbus (optional, disable with the -Ddbus=false meson configure flag)
  • libconfig (optional, disable with the -Dconfig_file=false meson configure flag)
  • libxdg-basedir (optional, disable with the -Dconfig_file=false meson configure flag)
  • libGL (optional, disable with the -Dopengl=false meson configure flag)
  • libpcre (optional, disable with the -Dregex=false meson configure flag)
  • libev

To build the documents, you need asciidoc

How to build

$ meson --buildtype=release . build
$ ninja -C build

Built binary can be found in build/src

How to Contribute

Code

You can look at the Projects page, and see if there is anything interests you. Or you can take a look at the Issues.

Non-code

Even if you don't want to contribute code, you can still contribute by compiling and running this branch, and report any issue you can find.

Contributors

See CONTRIBUTORS