forked from yshui/picom
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README, new fork, added screenshot
- Loading branch information
Showing
2 changed files
with
35 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,161 +1,68 @@ | ||
| picom | ||
| ======= | ||
| [**Click here for the official picom README**](https://github.com/yshui/picom) | ||
|
|
||
| [**Click here for the most recent branch of this fork**](https://github.com/ibhagwan/picom/tree/next-rebase) | ||
|
|
||
|  | ||
|
|
||
| ## Why another picom fork? | ||
|
|
||
| TL;DR: rounded corners and dual_kawase blur on all backends. | ||
| **TL;DR:** rounded corners and dual_kawase blur on all backends. | ||
|
|
||
| This fork contains: | ||
| ### This fork contains: | ||
|
|
||
| - Dual kawase blur method from [tryone144](https://github.com/tryone144/compton) as well as his new [feature/dual_kawase branch](https://github.com/tryone144/compton/tree/feature/dual_kawase) which implements the dual kawase blur method on the experimental glx backend. | ||
|
|
||
| - Rounded corners code from [sdhand](https://github.com/sdhand/picom) which is also ported to the experimetnal XRender backend. | ||
|
|
||
| - New code for rounded corners on the glx backend using GLSL frangment shader | ||
| - New code for rounded corners (+borders) on the glx backend using GLSL frangment shader for both legacy and experimental backends | ||
|
|
||
| For more information read [my reddit post](https://www.reddit.com/r/unixporn/comments/fs8trg/oc_comptonpicom_fork_with_both_tryone144s_dual/) | ||
|
|
||
| ## How to install | ||
|
|
||
| **This is a development branch, bugs to be expected** | ||
|
|
||
| This is forked from the original Compton because it 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. | ||
|
|
||
| The original README can be found [here](README_orig.md) | ||
|
|
||
| ## Call for testers | ||
|
|
||
| ### `--experimental-backends` | ||
|
|
||
| This flag enables the refactored/partially rewritten backends. | ||
|
|
||
| Currently, new backends feature better vsync with the xrender backend and 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 stabilize. | ||
|
|
||
| To test the new backends, add the `--experimental-backends` flag to the command you use to run picom. 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. | ||
|
|
||
| ## Rename | ||
|
|
||
| ### Rationale | ||
|
|
||
| Since the inception of this fork, the existence of two compton repositories has caused some number of confusions. Mainly, people will report issues of this fork to the original compton, or report issues of the original compton here. Later, when distros started packaging this fork of compton, some wanted to differentiate the newer compton from the older version. They found themselves having no choice but to invent a name for this fork. This is less than ideal since this has the potential to cause more confusions among users. | ||
|
|
||
| Therefore, we decided to move this fork to a new name. Personally, I consider this more than justified since this version of compton has gone through significant changes since it was forked. | ||
|
|
||
| ### The name | ||
|
|
||
| The criteria for a good name were | ||
|
|
||
| 0. Being short, so it's easy to remember. | ||
| 1. Pronounceability, again, helps memorability | ||
| 2. Searchability, so when people search the name, it's easy for them to find this repository. | ||
|
|
||
| Of course, choosing a name is never easy, and there is no apparent way to objectively evaluate the names. Yet, we have to solve the aforementioned problems as soon as possible. | ||
| ### Arch Linux | ||
|
|
||
| In the end, we picked `picom` (a portmanteau of `pico` and `composite`) as our new name. This name might not be perfect, but is what we will move forward with unless there's a compelling reason not to. | ||
|
|
||
| ### Migration | ||
|
|
||
| Following the [deprecation process](https://github.com/yshui/picom/issues/114), migration to the new name will be broken into 3 steps: | ||
|
|
||
| 1. All mentions of `compton` will be updated to `picom` in the code base. `compton` will still be installed, but only as a symlink to `picom`. When `picom` is launched via the symlink, a warning message is printed, alerting the user to migrate. Similarly, the old configuration file names and dbus interface names will still be accepted but warned. | ||
| 2. 3 major releases after step 1, the warning messages will be prompted to error messages and `picom` will not start when launched via the symlink. | ||
| 3. 3 major releases after step 2, the symlink will be removed. | ||
|
|
||
| The dbus interface and service names are unchanged, so no migration needed for that. | ||
|
|
||
| ## Change Log | ||
|
|
||
| See [Releases](https://github.com/yshui/picom/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) | ||
| * 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 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 libgl1-mesa-dev libpcre2-dev libevdev-dev uthash-dev libev-dev libx11-xcb-dev | ||
| Install [picom-ibhagwan-git](https://aur.archlinux.org/packages/picom-ibhagwan-git/) from the AUR using your favorite AUR helper such as `yay` | ||
| ```sh | ||
| ❯ yay -S picom-ibhagwan-git | ||
| ``` | ||
|
|
||
| To build the documents, you need `asciidoc` | ||
|
|
||
| ### To build | ||
|
|
||
| ```bash | ||
| $ git submodule update --init --recursive | ||
| $ meson --buildtype=release . build | ||
| $ ninja -C build | ||
| ``` | ||
| ### Void Linux | ||
|
|
||
| Built binary can be found in `build/src` | ||
| Follow the instructions found in [picom-ibhagwan-template](https://github.com/ibhagwan/picom-ibhagwan-template) | ||
|
|
||
| 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. | ||
| ### Build from source | ||
|
|
||
| You can do that by setting the `CPPFLAGS` and `LDFLAGS` environment variables when running `meson`. Like this: | ||
| Clone this repo and follow the [build instructions of the official picom README](https://github.com/yshui/picom/blob/next/README.md#build) | ||
|
|
||
| ```bash | ||
| $ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build | ||
|
|
||
| ``` | ||
| ## 2021-02-05 Update | ||
|
|
||
| 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 | ||
| ``` | ||
| It's been a while since this fork had some work and the good people at [the main picom branch](https://github.com/yshui/picom) merged some of this code into the main branch. | ||
|
|
||
| ### To install | ||
| However, not all code / features have been merged, ATM the status is as per the below: | ||
|
|
||
| ``` bash | ||
| $ ninja -C build install | ||
| ``` | ||
|
|
||
| Default install prefix is `/usr/local`, you can change it with `meson configure -Dprefix=<path> build` | ||
| ### Included in main branch | ||
|
|
||
| ## How to Contribute | ||
| - Rounded corners on legacy backends (both "glx" and "xrender") | ||
| - Dual-kawase blur on experimental "glx" backend only | ||
|
|
||
| ### Code | ||
| ### Not-included in main branch | ||
|
|
||
| You can look at the [Projects](https://github.com/yshui/picom/projects) page, and see if there is anything that interests you. Or you can take a look at the [Issues](https://github.com/yshui/picom/issues). | ||
| - Rounded corners with "--experimental-backends" | ||
| - Rounded borders on the legacy "glx" backend | ||
| - Rounded border rules on the legacy "glx" backend | ||
| - Dual-kawase blur on the legacy "glx" backend | ||
|
|
||
| ### Non-code | ||
| ### Updated fork | ||
|
|
||
| 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. | ||
| Since this fork was released a few issues were opened for bugs that were perhaps fixed in the main branch but not on this one, while I always recommend using the main branch as a better strategy than using older forked code, since not all features were yet implemented in the main branch I thought it might still be useful to rebase this fork on the most current work of the main branch. | ||
|
|
||
| Contributions to the documents and wiki will also be appreciated. | ||
| However, this fork has also been forked quite a few times (over 15), not being certain what work was done based on this fork or what new bugs the rebase will introduce I created a new branch ([**next-rebase**](https://github.com/ibhagwan/picom/tree/next-rebase)) for the rebased code. | ||
|
|
||
| ## Contributors | ||
| To pull the latest code residing in the `next-rebase` branch: | ||
|
|
||
| See [CONTRIBUTORS](CONTRIBUTORS) | ||
| ```sh | ||
| ❯ git clone --single-branch --branch next-rebase --depth=1 https://github.com/ibhagwan/picom | ||
| ``` |
