diff options
| author | William McKinnon <[email protected]> | 2024-04-30 02:09:59 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-04-30 02:09:59 -0400 |
| commit | bb349f578d696f741ffc677aa9f6db95732ea1a3 (patch) | |
| tree | 7e3936f9665251be531e3bbfd8cb311df3739569 | |
| parent | e6bc2467d43219f4b06beb3e750b66d444b679b2 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
@@ -1,2 +1,34 @@ # scenefx +wlroots is the de-facto library for building wayland compositors, and its scene api is a great stride in simplifying wayland compositor development. The problem with the scene api (for compositors looking for eye candy), however, is that it forces you to use the wlr renderer, which is powerful yet simple. SceneFX is a project that takes the scene api and replaces the wlr renderer with our own fx renderer, capable of rendering surfaces with eye-candy effects including blur, shadows, and rounded corners, while maintaining the benefits of simplicity gained from using the scene api. + +## Installation +<a href="https://repology.org/project/scenefx/versions"><img src="https://repology.org/badge/vertical-allrepos/scenefx.svg"/></a> + + +## Compiling From Source +Install dependencies: +* meson \* +* wlroots +* wayland +* wayland-protocols \* +* EGL and GLESv2 +* libdrm +* pixman + +_\* Compile-time dep_ + +Run these commands: +```sh +meson setup build/ +ninja -C build/ +``` + +Install like so: +```sh +sudo ninja -C build/ install +``` + + +--- +[Join our Discord](https://discord.gg/qsSx397rkh) |