docs: recommend packagers add a dependency on qtsvg

This commit is contained in:
outfoxxed 2024-06-02 15:37:47 -07:00
parent 29f02d837d
commit 9d5dd402b9
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
3 changed files with 21 additions and 15 deletions

View file

@ -10,6 +10,9 @@ Quickshell has a set of base dependencies you will always need, names vary by di
- `qt6declarative` - `qt6declarative`
- `pkg-config` - `pkg-config`
We recommend an implicit dependency on `qt6svg`. If it is not installed, svg images and
svg icons will not work, including system ones.
At least Qt 6.6 is required. At least Qt 6.6 is required.
All features are enabled by default and some have their own dependencies. All features are enabled by default and some have their own dependencies.

View file

@ -40,11 +40,12 @@ or disabled with overrides:
```nix ```nix
quickshell.packages.<system>.default.override { quickshell.packages.<system>.default.override {
enableWayland = true;
enableX11 = true;
enablePipewire = true;
withQtSvg = true;
withJemalloc = true; withJemalloc = true;
withQtSvg = true;
withWayland = true;
withX11 = true;
withPipewire = true;
withHyprland = true;
} }
``` ```

View file

@ -26,11 +26,12 @@
else "unknown"), else "unknown"),
debug ? false, debug ? false,
enableWayland ? true,
enableX11 ? true,
enablePipewire ? true,
withQtSvg ? true, # svg support
withJemalloc ? true, # masks heap fragmentation withJemalloc ? true, # masks heap fragmentation
withQtSvg ? true,
withWayland ? true,
withX11 ? true,
withPipewire ? true,
withHyprland ? true,
}: buildStdenv.mkDerivation { }: buildStdenv.mkDerivation {
pname = "quickshell${lib.optionalString debug "-debug"}"; pname = "quickshell${lib.optionalString debug "-debug"}";
version = "0.1.0"; version = "0.1.0";
@ -41,7 +42,7 @@
ninja ninja
qt6.wrapQtAppsHook qt6.wrapQtAppsHook
pkg-config pkg-config
] ++ (lib.optionals enableWayland [ ] ++ (lib.optionals withWayland [
wayland-protocols wayland-protocols
wayland-scanner wayland-scanner
]); ]);
@ -52,11 +53,11 @@
] ]
++ (lib.optional withJemalloc jemalloc) ++ (lib.optional withJemalloc jemalloc)
++ (lib.optional withQtSvg qt6.qtsvg) ++ (lib.optional withQtSvg qt6.qtsvg)
++ (lib.optionals enableWayland [ qt6.qtwayland wayland ]) ++ (lib.optionals withWayland [ qt6.qtwayland wayland ])
++ (lib.optional enableX11 xorg.libxcb) ++ (lib.optional withX11 xorg.libxcb)
++ (lib.optional enablePipewire pipewire); ++ (lib.optional withPipewire pipewire);
QTWAYLANDSCANNER = lib.optionalString enableWayland "${qt6.qtwayland}/libexec/qtwaylandscanner"; QTWAYLANDSCANNER = lib.optionalString withWayland "${qt6.qtwayland}/libexec/qtwaylandscanner";
configurePhase = let configurePhase = let
cmakeBuildType = if debug cmakeBuildType = if debug
@ -71,8 +72,9 @@
"-DGIT_REVISION=${gitRev}" "-DGIT_REVISION=${gitRev}"
] ]
++ lib.optional (!withJemalloc) "-DUSE_JEMALLOC=OFF" ++ lib.optional (!withJemalloc) "-DUSE_JEMALLOC=OFF"
++ lib.optional (!enableWayland) "-DWAYLAND=OFF" ++ lib.optional (!withWayland) "-DWAYLAND=OFF"
++ lib.optional (!enablePipewire) "-DSERVICE_PIPEWIRE=OFF"; ++ lib.optional (!withPipewire) "-DSERVICE_PIPEWIRE=OFF"
++ lib.optional (!withHyprland) "-DHYPRLAND=OFF";
buildPhase = "ninjaBuildPhase"; buildPhase = "ninjaBuildPhase";
enableParallelBuilding = true; enableParallelBuilding = true;