Skip to content

Commit

Permalink
doc: draw attention to release branches (#726)
Browse files Browse the repository at this point in the history
Using the wrong branch is a very common cause of questions, due to it
not being mentioned anywhere in the documentation.
  • Loading branch information
danth authored Jan 4, 2025
1 parent 2256b7d commit 18fd600
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ screens, and display managers.
```
<small>Minimal `flake.nix` for a NixOS configuration.</small>

If you are using a stable release of NixOS, ensure that you use the matching
Stylix release. For example:

```nix
{
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
stylix.url = "github:danth/stylix/release-24.11";
}
```

Many applications cannot be configured system wide, so Stylix will also need
[Home Manager][nix-hm] to be able to change their settings within your home
directory.
Expand Down Expand Up @@ -94,6 +104,17 @@ is managed by someone else.
```
<small>Minimal `flake.nix` for a Home Manager configuration.</small>

If you are using a stable release of Home Manager, ensure that you use the
matching Stylix release. For example:

```nix
{
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
home-manager.url = "github:nix-community/home-manager/release-24.11";
stylix.url = "github:danth/stylix/release-24.11";
}
```

If you choose to use both NixOS and Home Manager but configure them separately,
you will need to copy the settings described below into both of your
configurations, as keeping them separate means that they cannot follow each
Expand Down

0 comments on commit 18fd600

Please sign in to comment.