Skip to content

Commit

Permalink
hyprland: emphasize usage of the NixOS module
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealGramdalf authored Jul 4, 2024
1 parent 0a30138 commit c23060c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion modules/services/window-managers/hyprland.nix
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,21 @@ in {
];

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" { };

Expand Down

0 comments on commit c23060c

Please sign in to comment.