A lightweight compositor for X11
Go to file
Yuxuan Shui a252cbf028
clang-tidy: disable some noisy warnings
Also fix some of the warnings

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2022-08-23 05:19:06 +01:00
.builds ci: freebsd: add missing dependency 2020-10-25 07:03:29 +00:00
.circleci Make experimental backends the new default 2022-08-21 06:09:27 +01:00
.github issue_template: suggest uploading OpenGL traces 2022-08-12 11:19:47 +01:00
LICENSES More license stuff... 2018-10-04 11:18:09 +01:00
bin picom-trans: Added SPDX-License-Identifier 2021-07-23 21:15:53 +01:00
dbus-examples Update inverter.sh 2020-04-01 04:50:03 +00:00
man Merge pull request #875 from yshui/legacy-backend 2022-08-21 23:05:42 +01:00
media Added 48x48px raster of initial Compton logo 2015-09-17 21:57:11 -04:00
meson Made meson/install.sh executable 2022-04-12 05:41:41 +00:00
src clang-tidy: disable some noisy warnings 2022-08-23 05:19:06 +01:00
subprojects/test.h string_utils: add trim_both 2022-07-17 15:43:47 +01:00
tests Make experimental backends the new default 2022-08-21 06:09:27 +01:00
.clang-format file_watch: use kqueue on *BSD platforms 2019-11-11 21:22:57 +00:00
.clang-tidy clang-tidy: disable some noisy warnings 2022-08-23 05:19:06 +01:00
.editorconfig Coding style change 2019-02-07 21:37:13 +00:00
.gitignore gitignore: ignore language server indices 2020-08-30 17:57:05 +01:00
.gitmodules Vendor test.h 2019-08-04 13:49:28 +01:00
CONTRIBUTORS Update CONTRIBUTORS 2022-01-27 11:21:30 +00:00
COPYING rename: documentation changes 2019-10-23 20:24:25 +01:00
Doxyfile Fix small misspellings 2019-01-28 10:58:14 +01:00
History.md README: Move old historical info out of main README 2022-04-12 09:43:57 -04:00
LICENSE.spdx rename: documentation changes 2019-10-23 20:24:25 +01:00
README.md Make experimental backends the new default 2022-08-21 06:09:27 +01: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 .desktop files to NoDisplay=true 2020-12-14 14:54:33 +01:00
desc.txt Misc: #49: Add CMake support 2012-10-03 13:34:54 +08:00
meson.build meson.build: autostart picom 2022-08-21 06:25:55 +01:00
meson_options.txt meson: Allow building without compton compat. 2020-05-28 07:05:05 -07:00
picom-dbus.desktop set .desktop files to NoDisplay=true 2020-12-14 14:54:33 +01:00
picom.desktop meson.build: autostart picom 2022-08-21 06:25:55 +01:00
picom.sample.conf picom.sample.conf: add window-shader-fg and window-shader-fg-rule 2022-08-21 05:37:28 +01:00

README.md

picom

picom is a compositor for X, and a fork of Compton.

This is a development branch, bugs to be expected

You can leave your feedback or thoughts in the discussion tab.

Change Log

See Releases

Build

Dependencies

Assuming you already have all the usual building tools installed (e.g. gcc, python, 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
  • xcb-glx
  • 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
  • uthash

On Debian based distributions (e.g. Ubuntu), the needed packages are

libxext-dev libxcb1-dev libxcb-damage0-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render-util0-dev libxcb-render0-dev libxcb-randr0-dev libxcb-composite0-dev libxcb-image0-dev libxcb-present-dev libxcb-xinerama0-dev libxcb-glx0-dev libpixman-1-dev libdbus-1-dev libconfig-dev libgl1-mesa-dev libpcre2-dev libpcre3-dev libevdev-dev uthash-dev libev-dev libx11-xcb-dev meson

On Fedora, the needed packages are

dbus-devel gcc git libconfig-devel libdrm-devel libev-devel libX11-devel libX11-xcb libXext-devel libxcb-devel mesa-libGL-devel meson pcre-devel pixman-devel uthash-devel xcb-util-image-devel xcb-util-renderutil-devel xorg-x11-proto-devel

To build the documents, you need asciidoc

To build

$ git submodule update --init --recursive
$ 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/lib" 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 that 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.

Contributions to the documents and wiki will also be appreciated.

Contributors

See CONTRIBUTORS

The README for the original Compton project can be found here.

Licensing

picom is free software, made available under the MIT and MPL-2.0 software licenses. See the individual source files for details.