aboutsummaryrefslogtreecommitdiffstats
path: root/quickshell/README
diff options
context:
space:
mode:
Diffstat (limited to 'quickshell/README')
-rw-r--r--quickshell/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/quickshell/README b/quickshell/README
new file mode 100644
index 0000000..dea443c
--- /dev/null
+++ b/quickshell/README
@@ -0,0 +1,13 @@
+Quickshell is a toolkit for building status bars, widgets, lockscreens
+and other desktop components using QtQuick. It can be used alongside a
+Wayland compositor or window manager to build a complete desktop
+environment.
+
+Quickshell relies on private Qt APIs and must be rebuilt after every Qt
+update, or it will crash from ABI mismatches.
+
+Optional dependency: qt6-svg (detected automatically) enables SVG images
+and SVG icons, including system icon themes.
+
+The upstream crash reporter is disabled in this build, as it depends on
+cpptrace which is not packaged for Slackware.