b5d135df82
* Removed the AUTHORS section as recommended by man-pages(7), the conventions for writing Linux man pages. * Change the secion name to the more commonly used "User Commands". * Don't say "this man page might be out dated". * Always use the current version number of compton as "man version" in the man pages. Also bumped the project version in meson.build Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
Compton
This is a development branch, bug to be expected
This is forked from the original Compton because that seems to have become unmaintained. I'll merge pull requests as they appear upstream, as well as trying to fix bugs reported to upstream, or found by myself.
The original README can be found here
Build
Dependencies
Assuming you already have all the usual building tools installed (e.g. gcc, meson, ninja, etc.), you still need:
- libx11
- 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
-Dxinerama=falsemeson configure flag) - pixman
- libdbus (optional, disable with the
-Ddbus=falsemeson configure flag) - libconfig (optional, disable with the
-Dconfig_file=falsemeson configure flag) - libGL (optional, disable with the
-Dopengl=falsemeson configure flag) - libpcre (optional, disable with the
-Dregex=falsemeson 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