Skip to content

Commit

Permalink
docs(readme): add usage as Nix package (#61)
Browse files Browse the repository at this point in the history
Co-Authored-By: Ladas552 <[email protected]>
  • Loading branch information
NTBBloodbath and Ladas552 committed Feb 17, 2025
1 parent 53b9091 commit fef5325
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,38 @@ Options:

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

### 📦 Nix Package

You can add norgolith to your NixOS configuration with flakes

<details>
<summary>Minimal flake.nix for a NixOS configuration:</summary>

```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
norgolith.url = "github:NTBBloodbath/norgolith";
};
outputs =
{ nixpkgs, norgolith, ... }:
{
nixosConfigurations.mysystem = nixpkgs.lib.nixosSystem {
modules = [
{
# add norgolith as a package
environment.systemPackages = [
norgolith.packages.x86_64-linux.default
];
}
];
};
};
}
```
</details>

## ❄️ Developing and testing with Nix

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

0 comments on commit fef5325

Please sign in to comment.