15c7abcf41
Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com> |
||
---|---|---|
.circleci | ||
.github | ||
LICENSES | ||
bin | ||
dbus-examples | ||
man | ||
media | ||
src | ||
subprojects | ||
tests | ||
.clang-format | ||
.editorconfig | ||
.gitignore | ||
.gitmodules | ||
CONTRIBUTORS | ||
COPYING | ||
Doxyfile | ||
LICENSE.spdx | ||
README.md | ||
README_orig.md | ||
compton-default-fshader-win.glsl | ||
compton-fake-transparency-fshader-win.glsl | ||
compton.desktop | ||
compton.sample.conf | ||
desc.txt | ||
functions.sh | ||
make-release.sh | ||
meson.build | ||
meson_options.txt |
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
To build
$ meson --buildtype=release . build
$ ninja -C build
On FreeBSD, ld
does not look by default in /usr/local/lib, and you will get errors about some libraries being not found.
To fix that, prepend LDFLAGS="-L/usr/local/lib"
:
$ LDFLAGS="-L/usr/local/lib" meson --buildtype=release . build
$ ninja -C build
Built binary can be found in build/src
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