BitHeaven
/
picom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
640 Commits 1 Branch 0 Tags 17 MiB
C 96.1%
Shell 2.2%
Python 0.8%
Meson 0.8%
Go to file
Yuxuan Shui b5d135df82
Man page improvements 
* 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>
 		2018-12-15 16:36:42 +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 Replace "bashism" with POSIX syntax. 2018-04-16 10:13:55 -04:00
dbus-examples Update comments about clear-shadow 2018-09-24 00:20:28 +01:00
man Man page improvements 2018-12-15 16:36:42 +00:00
media Added 48x48px raster of initial Compton logo 2015-09-17 21:57:11 -04:00
src Swap control only works with OpenGL 2018-12-15 11:22:38 +02:00
tests Remove cmake leftovers 2018-12-14 17:13:30 +00:00
.editorconfig Add editorconfig 2018-09-10 13:46:05 +01:00
.gitignore Remove xrender-sync and xrender-sync-fence 2018-10-28 23:36:55 +00:00
CONTRIBUTORS Update CONTRIBUTORS 2018-12-15 14:59:43 +00:00
COPYING More license stuff... 2018-10-04 11:18:09 +01:00
Doxyfile Feature #51: Re-initialize when SIGUSR1 is received 2012-11-19 11:44:58 +08:00
LICENSE.spdx More license stuff... 2018-10-04 11:18:09 +01:00
Makefile Use libev for inputs and timeouts 2018-10-03 01:05:32 +01:00
README.md Add --diagnostics option 2018-11-03 22:37:18 +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 Clean up the wintype option logic 2018-12-04 15:13:08 +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 Man page improvements 2018-12-15 16:36:42 +00:00
meson_options.txt Make building the docs optional 2018-10-29 11:55:10 +00: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. 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=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)
  • 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