Skip to content

Commit cb815ef

Browse files
docs(readme): add usage as Nix package (#61)
Co-Authored-By: Ladas552 <[email protected]>
1 parent 3c1ac8d commit cb815ef

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,38 @@ Options:
7171

7272
Run `cargo install --release --path .` to compile and install Norgolith in your `~/.cargo/bin` directory.
7373

74+
### 📦 Nix Package
75+
76+
You can add norgolith to your NixOS configuration with flakes
77+
78+
<details>
79+
<summary>Minimal flake.nix for a NixOS configuration:</summary>
80+
81+
```nix
82+
{
83+
inputs = {
84+
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
85+
86+
norgolith.url = "github:NTBBloodbath/norgolith";
87+
};
88+
outputs =
89+
{ nixpkgs, norgolith, ... }:
90+
{
91+
nixosConfigurations.mysystem = nixpkgs.lib.nixosSystem {
92+
modules = [
93+
{
94+
# add norgolith as a package
95+
environment.systemPackages = [
96+
norgolith.packages.x86_64-linux.default
97+
];
98+
}
99+
];
100+
};
101+
};
102+
}
103+
```
104+
</details>
105+
74106
## ❄️ Developing and testing with Nix
75107

76108
The Norgolith repository includes a Nix flake for development and testing purposes in the root directory. This section outlines how to

0 commit comments

Comments
 (0)