hyprland: emphasize usage of the NixOS module

This commit is contained in:
TheRealGramdalf 2024-07-04 23:07:22 +00:00 committed by GitHub
parent 0a30138c69
commit c23060ce95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -40,7 +40,21 @@ in {
]; ];
options.wayland.windowManager.hyprland = { options.wayland.windowManager.hyprland = {
enable = lib.mkEnableOption "Hyprland wayland compositor"; enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Whether to enable configuration for Hyprland, a tiling Wayland
compositor that doesn't sacrifice on its looks.
::: {.note}
This module configures Hyprland and adds it to your user's {env}`PATH`,
but does not make certain system-level changes. NixOS users should
enable the NixOS module with {option}`programs.hyprland.enable`, which
makes system-level changes such as adding a desktop session entry.
:::
'';
};
package = lib.mkPackageOption pkgs "hyprland" { }; package = lib.mkPackageOption pkgs "hyprland" { };