PolytreeDE
/
picom
mirror of https://github.com/yshui/picom.git
1
0
Fork 0
Code Releases Activity

rename: documentation changes 

Update names in COPYING, LICENSE.spdx. Document information regarding
the rename in README.md

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
This commit is contained in:
Yuxuan Shui 2019-10-23 19:59:07 +01:00
parent ed0e686f37
commit 902ad5ddf9
No known key found for this signature in database
GPG Key ID: 37C999F617EA1A47
3 changed files with 33 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
COPYING
View File

@ -1,11 +1,11 @@
compton - a compositor for X11
picom - a compositor for X11
Based on xcompmgr, originally written by Keith Packard, with modifications
from several contributors (according to the xcompmgr man page): Matthew Allum,
Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell,
and Carl Worth. Menu transparency was implemented by Dana Jansens.
Numerous contributions to compton from Richard Grenville.
Numerous contributions to picom from Richard Grenville.
See the CONTRIBUTORS file for a complete list of contributors

2
LICENSE.spdx
View File

@ -1,4 +1,4 @@
SPDXVersion: SPDX-2.1
DataLicense: CC0-1.0
PackageName: compton
PackageName: picom
PackageLicenseDeclared: MPL-2.0 AND MIT

30
README.md
View File

@ -25,6 +25,36 @@ To test the new backends, add the `--experimental-backends` flag to the command
To report issues with the new backends, please state explicitly you are using the new backends in your report.
## Rename
### Rational
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 searches 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 aforementioned problems as soon as possible.
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/compton/issues/114), migration to the new name will be broken into 3 steps:
1. All mentions to `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/compton/releases)