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-12-22 05:23:45 +08:00
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
2018-12-16 03:57:57 +08:00
## Changelog
See [Releases ](https://github.com/yshui/compton/releases )
2018-10-01 21:26:57 +08:00
## Build
### Dependencies
2018-10-15 07:47:24 +08:00
Assuming you already have all the usual building tools installed (e.g. gcc, meson, ninja, etc.), you still need:
2018-10-01 21:26:57 +08:00
* libx11
2018-12-17 00:36:15 +08:00
* libx11-xcb
2018-10-01 21:26:57 +08:00
* libXext
* xproto
* xcb
* xcb-damage
* xcb-xfixes
* xcb-shape
* xcb-renderutil
* xcb-render
* xcb-randr
* xcb-composite
* xcb-image
2018-11-04 06:15:38 +08:00
* xcb-present
2018-12-16 03:44:11 +08:00
* xcb-xinerama (optional, disable with the `-Dxinerama=false` meson configure flag)
2018-10-01 21:26:57 +08:00
* pixman
2018-10-15 07:47:24 +08:00
* libdbus (optional, disable with the `-Ddbus=false` meson configure flag)
* libconfig (optional, disable with the `-Dconfig_file=false` meson configure flag)
2018-12-16 03:44:11 +08:00
* libxdg-basedir (optional, disable with the `-Dconfig_file=false` meson configure flag)
2018-10-15 07:47:24 +08:00
* 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
2019-04-03 15:36:02 +08:00
* uthash
2018-10-01 21:26:57 +08:00
To build the documents, you need `asciidoc`
2019-02-22 02:24:46 +08:00
### To build
2018-10-01 21:26:57 +08:00
```bash
2018-10-15 18:12:45 +08:00
$ meson --buildtype=release . build
2018-10-15 07:47:24 +08:00
$ ninja -C build
2018-10-01 21:26:57 +08:00
```
2019-03-28 03:31:50 +08:00
On FreeBSD, `ld` does not look by default in /usr/local/lib, and you will get errors about some libraries being not found.
2019-03-28 05:09:05 +08:00
To fix that, prepend `LDFLAGS="-L/usr/local/lib"` :
2019-03-28 03:31:50 +08:00
```bash
$ LDFLAGS="-L/usr/local/lib" meson --buildtype=release . build
$ ninja -C build
```
2018-10-21 08:18:24 +08:00
Built binary can be found in `build/src`
2018-10-15 07:47:24 +08:00
2019-02-22 02:24:46 +08:00
### To install
``` bash
$ ninja -C build install
```
Default install prefix is `/usr/local` , you can change it with `meson configure -Dprefix=<path> build`
2018-10-01 21:26:57 +08:00
## 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.
2018-10-04 05:14:51 +08:00
## Contributors
See [CONTRIBUTORS ](CONTRIBUTORS )
