PolytreeDE/picom
1
0
Fork 0
mirror of https://github.com/yshui/picom.git synced 2024-11-03 04:33:49 -05:00
Code Releases Activity
picom/README.md

113 lines
3.5 KiB
Markdown
Raw Normal View History

Update README.md
2019-10-25 06:06:15 -04:00
picom
README: Move old historical info out of main README The picom project is no longer a fledgling fork needing to justify its existence. The README should present the user with relevant information regarding the current project rather than apologies for a 6-year-old fork of a longer-defunct prior project. 1. Rename README_orig.md to History.md, so it can contain other content of a historical nature. 2. Move still-relevant historical content from README to History. 3. Add a brief intro blurb to README saying that picom is an X compositor. 4. Mention Compton in the CONTRIBUTORS section. 5. Point to licensing information from README.
2022-04-12 08:48:21 -04:00
=====
add readme
2011-11-04 14:52:05 -04:00
README: Move old historical info out of main README The picom project is no longer a fledgling fork needing to justify its existence. The README should present the user with relevant information regarding the current project rather than apologies for a 6-year-old fork of a longer-defunct prior project. 1. Rename README_orig.md to History.md, so it can contain other content of a historical nature. 2. Move still-relevant historical content from README to History. 3. Add a brief intro blurb to README saying that picom is an X compositor. 4. Mention Compton in the CONTRIBUTORS section. 5. Point to licensing information from README.
2022-04-12 08:48:21 -04:00
__picom__ is a compositor for X, and a [fork of Compton](History.md).
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-12-21 16:23:45 -05:00
README: Move old historical info out of main README The picom project is no longer a fledgling fork needing to justify its existence. The README should present the user with relevant information regarding the current project rather than apologies for a 6-year-old fork of a longer-defunct prior project. 1. Rename README_orig.md to History.md, so it can contain other content of a historical nature. 2. Move still-relevant historical content from README to History. 3. Add a brief intro blurb to README saying that picom is an X compositor. 4. Mention Compton in the CONTRIBUTORS section. 5. Point to licensing information from README.
2022-04-12 08:48:21 -04:00
**This is a development branch, bugs to be expected**
Update README.md
2020-12-16 19:25:57 -05:00
README: Move old historical info out of main README The picom project is no longer a fledgling fork needing to justify its existence. The README should present the user with relevant information regarding the current project rather than apologies for a 6-year-old fork of a longer-defunct prior project. 1. Rename README_orig.md to History.md, so it can contain other content of a historical nature. 2. Move still-relevant historical content from README to History. 3. Add a brief intro blurb to README saying that picom is an X compositor. 4. Mention Compton in the CONTRIBUTORS section. 5. Point to licensing information from README.
2022-04-12 08:48:21 -04:00
You can leave your feedback or thoughts in the [discussion tab](https://github.com/yshui/picom/discussions).
add readme
2011-11-04 14:52:05 -04:00
README: Call for testers Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-05-21 17:16:09 -04:00
## Change Log
Update README.md Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-12-15 14:57:57 -05:00
Update links to git repo Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-10-24 14:24:38 -04:00
See [Releases](https://github.com/yshui/picom/releases)
Update README.md Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-12-15 14:57:57 -05:00
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
## Build
### Dependencies
README: add Ubuntu specific package names It could be hard for Ubuntu/Debian users to find the correct packages for the dependencies. Thanks @kgilmer Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-08-18 17:39:18 -04:00
Assuming you already have all the usual building tools installed (e.g. gcc, python, meson, ninja, etc.), you still need:
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
* libx11
Build with more config combinations Also add missing dependency to readme Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-12-16 11:36:15 -05:00
* libx11-xcb
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
* libXext
* xproto
* xcb
* xcb-damage
* xcb-xfixes
* xcb-shape
* xcb-renderutil
* xcb-render
* xcb-randr
* xcb-composite
* xcb-image
Add --diagnostics option It will cause compton to print out some rudimentary diagnostics. Also small improvements of the meson.build. Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-11-03 18:15:38 -04:00
* xcb-present
README: Call for testers Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-05-21 17:16:09 -04:00
* xcb-xinerama
x: fix glx error codes compton was using wrong set of constants as glx error codes. Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2020-03-31 00:59:44 -04:00
* xcb-glx
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
* pixman
Update building instructions in README.md
2018-10-14 19:47:24 -04:00
* libdbus (optional, disable with the `-Ddbus=false` meson configure flag)
* libconfig (optional, disable with the `-Dconfig_file=false` meson configure flag)
README: add libEGL dependency Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2022-08-23 00:48:21 -04:00
* libGL, libEGL (optional, disable with the `-Dopengl=false` meson configure flag)
Update building instructions in README.md
2018-10-14 19:47:24 -04:00
* libpcre (optional, disable with the `-Dregex=false` meson configure flag)
Update README
2018-10-02 20:09:37 -04:00
* libev
win: track windows with a hash table Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-04-03 03:36:02 -04:00
* uthash
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
Add packages needed for building on Fedora to README.
2021-01-04 16:52:43 -05:00
On Debian based distributions (e.g. Ubuntu), the needed packages are
README: add Ubuntu specific package names It could be hard for Ubuntu/Debian users to find the correct packages for the dependencies. Thanks @kgilmer Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-08-18 17:39:18 -04:00
```
README: add libEGL dependency Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2022-08-23 00:48:21 -04:00
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 libxcb-glx0-dev libpixman-1-dev libdbus-1-dev libconfig-dev libgl-dev libegl-dev libpcre2-dev libpcre3-dev libevdev-dev uthash-dev libev-dev libx11-xcb-dev meson
README: add Ubuntu specific package names It could be hard for Ubuntu/Debian users to find the correct packages for the dependencies. Thanks @kgilmer Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-08-18 17:39:18 -04:00
```
Add packages needed for building on Fedora to README.
2021-01-04 16:52:43 -05:00
On Fedora, the needed packages are
```
README: add libEGL dependency Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2022-08-23 00:48:21 -04:00
dbus-devel gcc git libconfig-devel libdrm-devel libev-devel libX11-devel libX11-xcb libXext-devel libxcb-devel libGL-devel libEGL-devel meson pcre-devel pixman-devel uthash-devel xcb-util-image-devel xcb-util-renderutil-devel xorg-x11-proto-devel
Add packages needed for building on Fedora to README.
2021-01-04 16:52:43 -05:00
```
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
To build the documents, you need `asciidoc`
Add install instructions to README Closes #120 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-02-21 13:24:46 -05:00
### To build
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
```bash
README: mention git submodule in Build section Fixes #179 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-05-24 19:13:47 -04:00
$ git submodule update --init --recursive
Update README.md
2018-10-15 06:12:45 -04:00
$ meson --buildtype=release . build
Update building instructions in README.md
2018-10-14 19:47:24 -04:00
$ ninja -C build
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
```
README: mentions how to specify header/library path Closes #155 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-04-14 08:32:33 -04:00
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:
Added FreeBSD build instructions
2019-03-27 15:31:50 -04:00
```bash
README: mentions how to specify header/library path Closes #155 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-04-14 08:32:33 -04:00
$ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build
Added FreeBSD build instructions
2019-03-27 15:31:50 -04:00
```
README: mentions how to specify header/library path Closes #155 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-04-14 08:32:33 -04:00
As an example, on FreeBSD, you might have to run meson with:
```bash
README: fix typo Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2020-10-24 22:57:34 -04:00
$ LDFLAGS="-L/usr/local/lib" CPPFLAGS="-I/usr/local/include" meson --buildtype=release . build
README: mentions how to specify header/library path Closes #155 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-04-14 08:32:33 -04:00
$ ninja -C build
```
Update building instructions in README.md
2018-10-14 19:47:24 -04:00
Add install instructions to README Closes #120 Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-02-21 13:24:46 -05:00
### To install
``` bash
$ ninja -C build install
```
Default install prefix is `/usr/local`, you can change it with `meson configure -Dprefix=<path> build`
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
## How to Contribute
### Code
Updated README Rationale: - "bug to be expected" -> "bugs to be expected". Usually the noun is plural in this expression (since more than one bug is likely to be found in the future). - "because that seems to be unmaintained" -> "because it seems to be unmaintained". Using a demonstrative pronoun ("that") versus a personal pronoun ("it") suggests that we need to specify which of several Comptons is unmaintained. - "features" -> "feature" and "stabilizes" -> "stabilize". The new backends are plural, should be conjugated without the trailing "s". - "used" -> "use". The command used to launch picom has already been run. Changing to "use" indicates the command that habitually launches picom. Also changed "command line" (the interface, e.g. the prompt) to "command". - "Rational" (adjective: based on reason) -> "Rationale" (noun: the reasons or logic that motivated an action) - "when people searches" -> "when people search". Usually conjugated as plural [1](https://english.stackexchange.com/q/263046) - "to solve aforementioned problems" -> "to solve the aforementioned problems". "Aforementioned" is preceded by a definite article when modifying a noun. - "mentions to" (usually used in suggesting an 'honourable mention'/accolade regarding somebody) -> "mentions of" (instances of)
2019-11-04 15:43:18 -05:00
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).
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2018-10-01 09:26:57 -04:00
### 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.
Sort out license problems IANAL, but I think I am allowed to add missing copyright notices for someone else. And I did my best job using git history to figure out who wrote which functions. So I hope everything is fine.
2018-10-03 17:14:51 -04:00
Update README Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2019-05-21 17:16:40 -04:00
Contributions to the documents and wiki will also be appreciated.
Sort out license problems IANAL, but I think I am allowed to add missing copyright notices for someone else. And I did my best job using git history to figure out who wrote which functions. So I hope everything is fine.
2018-10-03 17:14:51 -04:00
## Contributors
See [CONTRIBUTORS](CONTRIBUTORS)
README: Move old historical info out of main README The picom project is no longer a fledgling fork needing to justify its existence. The README should present the user with relevant information regarding the current project rather than apologies for a 6-year-old fork of a longer-defunct prior project. 1. Rename README_orig.md to History.md, so it can contain other content of a historical nature. 2. Move still-relevant historical content from README to History. 3. Add a brief intro blurb to README saying that picom is an X compositor. 4. Mention Compton in the CONTRIBUTORS section. 5. Point to licensing information from README.
2022-04-12 08:48:21 -04:00
The README for the [original Compton project](https://github.com/chjj/compton/) can be found [here](History.md#Compton).
## Licensing
picom is free software, made available under the [MIT](LICENSES/MIT) and [MPL-2.0](LICENSES/MPL-2.0) software
licenses. See the individual source files for details.
Copy permalink