A lightweight compositor for X11
Go to file
Yuxuan Shui c55088944a
new backend: glx: use glFinish/glXWaitGL if not on NVIDIA
Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-05-21 20:15:31 +01:00
.circleci Make ubsan stricter 2019-05-21 20:15:25 +01:00
.github
LICENSES
bin
dbus-examples
man Dump damage region info in trace log 2019-05-21 20:15:24 +01:00
media
src new backend: glx: use glFinish/glXWaitGL if not on NVIDIA 2019-05-21 20:15:31 +01:00
subprojects Add test.h as submodule 2019-05-21 20:15:22 +01:00
tests
.clang-format new glx: implement blur 2019-03-10 01:22:38 +00:00
.editorconfig Coding style change 2019-02-07 21:37:13 +00:00
.gitignore
.gitmodules Add test.h as submodule 2019-05-21 20:15:22 +01:00
CONTRIBUTORS Update CONTRIBUTORS 2019-01-30 22:47:02 +00:00
COPYING
Doxyfile
LICENSE.spdx
README.md README: mentions how to specify header/library path 2019-05-21 20:15:29 +01:00
README_orig.md
compton-default-fshader-win.glsl
compton-fake-transparency-fshader-win.glsl
compton.desktop
compton.sample.conf Deprecate --glx-swap-method 2019-03-12 00:35:47 +00:00
desc.txt
functions.sh
make-release.sh
meson.build build: check if std-predef.h exists 2019-05-21 20:15:28 +01:00
meson_options.txt Add some unittests 2019-05-21 20:15:22 +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
  • uthash

To build the documents, you need asciidoc

To build

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

Built binary can be found in build/src

If you have libraries and/or headers installed at non-default location (e.g. under /usr/local/), you might need to tell meson about them, since meson doesn't look for dependencies there by default.

You can do that by setting the CPPFLAGS and LDFLAGS environment variables when running meson. Like this:

$ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build

As an example, on FreeBSD, you might have to run meson with:

$ LDFLAGS="-L/usr/local/include" CPPFLAGS="-I/usr/local/include" meson --buildtype=release . build
$ ninja -C build

To install

$ ninja -C build install

Default install prefix is /usr/local, you can change it with meson configure -Dprefix=<path> build

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