From 0abffbe6def159d72f8f00302d6c8f9f8250f580 Mon Sep 17 00:00:00 2001 From: William McKinnon Date: Tue, 30 Apr 2024 02:13:04 -0400 Subject: added note about project readiness --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ce0b77b..8bdca76 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ 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. +**Please note: while SceneFX is in use by SwayFX version 0.4, it is not yet ready for usage by other compositors. Please refer to the [1.0 milestone](https://github.com/wlrfx/scenefx/milestone/2) to track the remaining tasks for our stable 1.0 release** + ## Installation -- cgit v1.2.3