From bb349f578d696f741ffc677aa9f6db95732ea1a3 Mon Sep 17 00:00:00 2001 From: William McKinnon Date: Tue, 30 Apr 2024 02:09:59 -0400 Subject: Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index b1ec848..ce0b77b 100644 --- a/README.md +++ b/README.md @@ -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 + + + +## 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) -- cgit v1.2.3