Skip to content

Commit 11379e7

Browse files
committed
docs(nix): fix install examples and document git integration requirement
1 parent 186c2c2 commit 11379e7

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

nix/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,23 @@ Nix users can install Hunk from source instead of using npm.
1717
}
1818
```
1919

20-
2. Use in NixOS `environment.systemPackages` or `home.packages`:
20+
2. Use in NixOS `environment.systemPackages`:
2121

2222
```nix
2323
{
24-
packages = [
25-
inputs.hunk.packages.${pkgs.stdenv.hostPlatform.system}.default
26-
]
24+
environment.systemPackages = [
25+
inputs.hunk.packages.${pkgs.stdenv.hostPlatform.system}.default
26+
];
27+
}
28+
```
29+
30+
Or in Home Manager `home.packages`:
31+
32+
```nix
33+
{
34+
home.packages = [
35+
inputs.hunk.packages.${pkgs.stdenv.hostPlatform.system}.default
36+
];
2737
}
2838
```
2939

@@ -51,6 +61,8 @@ Hunk provides a Home Manager module to manage both the package and its configura
5161
}
5262
```
5363

64+
`enableGitIntegration` writes to Home Manager's Git configuration, so it requires Home Manager's Git module to be enabled with `programs.git.enable = true;`.
65+
5466
## Updating Hunk
5567

5668
Flake users update Hunk by updating their own pinned `flake.lock` input:

0 commit comments

Comments
 (0)