quickshell/quickshell
1
1
Fork 2
Code Issues Wiki Activity

docs: document private ABI usage

Browse source
This commit is contained in:
outfoxxed 2026-05-21 23:12:13 -07:00
parent 7d1c9a9c67
commit 4b4fca3224
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
1 changed files with 3 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
BUILD.md
View file

@ -39,6 +39,9 @@ Quickshell has a set of base dependencies you will always need, names vary by di
- `pkg-config` (build-time)
- `cli11` (static library)
Quickshell relies on private Qt APIs and **MUST** be rebuilt against the each Qt release
or crashes via ABI mismatches will occur.
Build time dependencies and static libraries don't have to exist at runtime,
however build time dependencies must be compiled for the architecture of
the builder, while static libraries must be compiled for the architecture
@ -97,13 +100,6 @@ To disable: `-DSOCKETS=OFF`
### Wayland
This feature enables wayland support. Subfeatures exist for each particular wayland integration.
WARNING: Wayland integration relies on features that are not part of the public Qt API and which
may break in minor releases. Updating quickshell's dependencies without ensuring without ensuring
that the current Qt version is supported WILL result in quickshell failing to build or misbehaving
at runtime.
Currently supported Qt versions: `6.6`, `6.7`.
To disable: `-DWAYLAND=OFF`
Dependencies: