forked from quickshell/quickshell
		
	docs: recommend packagers add a dependency on qtsvg
This commit is contained in:
		
							parent
							
								
									29f02d837d
								
							
						
					
					
						commit
						9d5dd402b9
					
				
					 3 changed files with 21 additions and 15 deletions
				
			
		
							
								
								
									
										3
									
								
								BUILD.md
									
										
									
									
									
								
							
							
						
						
									
										3
									
								
								BUILD.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -10,6 +10,9 @@ Quickshell has a set of base dependencies you will always need, names vary by di
 | 
			
		|||
- `qt6declarative`
 | 
			
		||||
- `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.
 | 
			
		||||
 | 
			
		||||
All features are enabled by default and some have their own dependencies.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -40,11 +40,12 @@ or disabled with overrides:
 | 
			
		|||
 | 
			
		||||
```nix
 | 
			
		||||
quickshell.packages.<system>.default.override {
 | 
			
		||||
  enableWayland = true;
 | 
			
		||||
  enableX11 = true;
 | 
			
		||||
  enablePipewire = true;
 | 
			
		||||
  withQtSvg = true;
 | 
			
		||||
  withJemalloc = true;
 | 
			
		||||
  withQtSvg = true;
 | 
			
		||||
  withWayland = true;
 | 
			
		||||
  withX11 = true;
 | 
			
		||||
  withPipewire = true;
 | 
			
		||||
  withHyprland = true;
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										24
									
								
								default.nix
									
										
									
									
									
								
							
							
						
						
									
										24
									
								
								default.nix
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -26,11 +26,12 @@
 | 
			
		|||
     else "unknown"),
 | 
			
		||||
 | 
			
		||||
  debug ? false,
 | 
			
		||||
  enableWayland ? true,
 | 
			
		||||
  enableX11 ? true,
 | 
			
		||||
  enablePipewire ? true,
 | 
			
		||||
  withQtSvg ? true, # svg support
 | 
			
		||||
  withJemalloc ? true, # masks heap fragmentation
 | 
			
		||||
  withQtSvg ? true,
 | 
			
		||||
  withWayland ? true,
 | 
			
		||||
  withX11 ? true,
 | 
			
		||||
  withPipewire ? true,
 | 
			
		||||
  withHyprland ? true,
 | 
			
		||||
}: buildStdenv.mkDerivation {
 | 
			
		||||
  pname = "quickshell${lib.optionalString debug "-debug"}";
 | 
			
		||||
  version = "0.1.0";
 | 
			
		||||
| 
						 | 
				
			
			@ -41,7 +42,7 @@
 | 
			
		|||
    ninja
 | 
			
		||||
    qt6.wrapQtAppsHook
 | 
			
		||||
    pkg-config
 | 
			
		||||
  ] ++ (lib.optionals enableWayland [
 | 
			
		||||
  ] ++ (lib.optionals withWayland [
 | 
			
		||||
    wayland-protocols
 | 
			
		||||
    wayland-scanner
 | 
			
		||||
  ]);
 | 
			
		||||
| 
						 | 
				
			
			@ -52,11 +53,11 @@
 | 
			
		|||
  ]
 | 
			
		||||
  ++ (lib.optional withJemalloc jemalloc)
 | 
			
		||||
  ++ (lib.optional withQtSvg qt6.qtsvg)
 | 
			
		||||
  ++ (lib.optionals enableWayland [ qt6.qtwayland wayland ])
 | 
			
		||||
  ++ (lib.optional enableX11 xorg.libxcb)
 | 
			
		||||
  ++ (lib.optional enablePipewire pipewire);
 | 
			
		||||
  ++ (lib.optionals withWayland [ qt6.qtwayland wayland ])
 | 
			
		||||
  ++ (lib.optional withX11 xorg.libxcb)
 | 
			
		||||
  ++ (lib.optional withPipewire pipewire);
 | 
			
		||||
 | 
			
		||||
  QTWAYLANDSCANNER = lib.optionalString enableWayland "${qt6.qtwayland}/libexec/qtwaylandscanner";
 | 
			
		||||
  QTWAYLANDSCANNER = lib.optionalString withWayland "${qt6.qtwayland}/libexec/qtwaylandscanner";
 | 
			
		||||
 | 
			
		||||
  configurePhase = let
 | 
			
		||||
    cmakeBuildType = if debug
 | 
			
		||||
| 
						 | 
				
			
			@ -71,8 +72,9 @@
 | 
			
		|||
    "-DGIT_REVISION=${gitRev}"
 | 
			
		||||
  ]
 | 
			
		||||
  ++ lib.optional (!withJemalloc) "-DUSE_JEMALLOC=OFF"
 | 
			
		||||
  ++ lib.optional (!enableWayland) "-DWAYLAND=OFF"
 | 
			
		||||
  ++ lib.optional (!enablePipewire) "-DSERVICE_PIPEWIRE=OFF";
 | 
			
		||||
  ++ lib.optional (!withWayland) "-DWAYLAND=OFF"
 | 
			
		||||
  ++ lib.optional (!withPipewire) "-DSERVICE_PIPEWIRE=OFF"
 | 
			
		||||
  ++ lib.optional (!withHyprland) "-DHYPRLAND=OFF";
 | 
			
		||||
 | 
			
		||||
  buildPhase = "ninjaBuildPhase";
 | 
			
		||||
  enableParallelBuilding = true;
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue