picom/README.md

95 lines
2.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**
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
## Changelog
See [Releases](https://github.com/yshui/compton/releases)
## Build
### Dependencies
Assuming you already have all the usual building tools installed (e.g. gcc, 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 (optional, disable with the `-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)
* 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
To build the documents, you need `asciidoc`
### 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/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.
## Contributors
See [CONTRIBUTORS](CONTRIBUTORS)