Update readme
scenefx
This commit is contained in:
@@ -5,6 +5,8 @@
|
|||||||
- [peachwm](#peachwm-1)
|
- [peachwm](#peachwm-1)
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Dependencies](#dependencies)
|
- [Dependencies](#dependencies)
|
||||||
|
- [SceneFX effects](#scenefx-effects)
|
||||||
|
- [Features](#features-1)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Roadmap](#roadmap)
|
- [Roadmap](#roadmap)
|
||||||
@@ -30,6 +32,7 @@ PeachWM is maintained by [HuntedByTheIRS](https://github.com/HuntedByTheIRS).
|
|||||||
- libinput
|
- libinput
|
||||||
- wayland
|
- wayland
|
||||||
- wlroots-0.20 (compiled with the libinput backend)
|
- wlroots-0.20 (compiled with the libinput backend)
|
||||||
|
- [scenefx](https://github.com/wlrfx/scenefx) (for rendering effects)
|
||||||
- xkbcommon
|
- xkbcommon
|
||||||
- wayland-protocols (compile-time only)
|
- wayland-protocols (compile-time only)
|
||||||
- pkg-config (compile-time only)
|
- pkg-config (compile-time only)
|
||||||
@@ -39,6 +42,18 @@ Install these (and their `-devel` versions if your distro has separate
|
|||||||
development packages) and run `make` followed by `doas/sudo make install`,
|
development packages) and run `make` followed by `doas/sudo make install`,
|
||||||
if you wish to install it (installs to /usr/local/bin/ by default).
|
if you wish to install it (installs to /usr/local/bin/ by default).
|
||||||
|
|
||||||
|
## SceneFX
|
||||||
|
|
||||||
|
PeachWM uses [scenefx](https://github.com/wlrfx/scenefx) for rendering
|
||||||
|
eye-candy effects on screen. These effects are now considered stable and
|
||||||
|
no longer experimental.
|
||||||
|
|
||||||
|
### Effects
|
||||||
|
|
||||||
|
- **Rounded corners** — smooth, configurable corner rounding on windows
|
||||||
|
- **Shadows** — drop shadows for windows
|
||||||
|
- More effects are planned and on the way.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Read example/config.lua. It should give
|
Read example/config.lua. It should give
|
||||||
|
|||||||
Reference in New Issue
Block a user