picom/README.md

118 lines
3.8 KiB
Markdown
Raw Normal View History

2016-10-09 02:34:44 +08:00
Compton
=======
2011-11-05 02:52:05 +08:00
2018-09-08 22:12:33 +08:00
**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.
2018-05-21 21:19:48 +08:00
2016-10-09 02:34:44 +08:00
The original README can be found [here](README_orig.md)
2011-11-05 02:52:05 +08:00
## Call for testers
### `--experimental-backends`
This flag enables the refactored/partially rewritten backends.
Currently new backends features better vsync with the xrender backend, improved input lag with the glx backend (for non-NVIDIA users). The performance should be on par with the old backends.
New backend features will only be implemented on the new backends from now on, and the old backends will eventually be phased out after the new backends stabilizes.
To test the new backends, add the `--experimental-backends` flag to the command line you used to run compton. This flag is not available from the configuration file.
To report issues with the new backends, please state explicitly you are using the new backends in your report.
## Change Log
See [Releases](https://github.com/yshui/compton/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
* 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)
2018-10-03 08:09:37 +08:00
* libev
* uthash
On Debian based distributions (e.g. Ubuntu), the list of 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 libpixman-1-dev libdbus-1-dev libconfig-dev libxdg-basedir-dev libgl1-mesa-dev libpcre2-dev libevdev-dev uthash-dev libevdev2
```
To build the documents, you need `asciidoc`
### To build
```bash
$ git submodule update --init --recursive
2018-10-15 18:12:45 +08:00
$ 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:
2019-03-28 03:31:50 +08:00
```bash
$ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build
2019-03-28 03:31:50 +08:00
```
As an example, on FreeBSD, you might have to run meson with:
```bash
$ LDFLAGS="-L/usr/local/include" CPPFLAGS="-I/usr/local/include" meson --buildtype=release . build
$ ninja -C build
```
### To install
``` bash
$ 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](https://github.com/yshui/compton/projects) page, and see if there is anything interests you. Or you can take a look at the [Issues](https://github.com/yshui/compton/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](CONTRIBUTORS)