picom/README.md

60 lines
1.6 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**
2018-05-21 21:19:48 +08:00
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.
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
## 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-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)
2018-10-03 08:09:37 +08:00
* libev
To build the documents, you need `asciidoc`
### How to build
```bash
2018-10-15 18:12:45 +08:00
$ meson --buildtype=release . build
$ ninja -C build
```
Built binary can be found in `build/bin`
## 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.
## Contributors
See [CONTRIBUTORS](CONTRIBUTORS)