Skip to content

Commit

Permalink
README: add Nix warning
Browse files Browse the repository at this point in the history
fufexan committed Sep 1, 2024
1 parent 2425e8f commit 482b569
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -29,6 +29,22 @@ cmake --build build
sudo cmake --install build
```

## Nix

> [!CAUTION] XDPH should not be used from this flake directly!
>
> Instead, use it from the [Hyprland flake](https://github.com/hyprwm/Hyprland).
There are two reasons for the above:

1. Hyprland depends on XDPH, but XDPH also depends on Hyprland. This results in
a cyclic dependency, which is a nightmare. To counter this, we use the
Nixpkgs Hyprland package in this flake, so that it can be later consumed by
the Hyprland flake while overriding the Hyprland package.
2. Even if you manually do all the overriding, you may still get it wrong and
lose out on the Cachix cache (which has XDPH as exposed by the Hyprland
flake).

## Running, FAQs, etc.

See

0 comments on commit 482b569

Please sign in to comment.