docs: add home-manager installation instructions to README
Some checks failed
Continuous Integration / Build Package (push) Successful in 35s
Continuous Integration / Lint, Check & Test (push) Failing after 55s

This commit is contained in:
Konstantin Fickel 2026-02-14 11:19:15 +01:00
parent eef9712924
commit fd09d127f2
Signed by: kfickel
GPG key ID: A793722F9933C1A5

View file

@ -162,6 +162,41 @@ bulkgen tracks the state of each build in `.bulkgen.state.yaml` (auto-generated,
- Model name
- Extra parameters (width, height, etc.)
## Installation with Nix / home-manager
bulkgen provides a Nix flake with a home-manager module. Add the flake as an input and enable the module:
```nix
# flake.nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
home-manager.url = "github:nix-community/home-manager";
bulkgen.url = "github:kfickel/bulkgen"; # adjust to your actual repo URL
};
outputs = { nixpkgs, home-manager, bulkgen, ... }: {
# ... your existing config, then in homeConfigurations:
homeConfigurations."user" = home-manager.lib.homeManagerConfiguration {
# ...
modules = [
bulkgen.homeManagerModules.bulkgen
{
programs.bulkgen.enable = true;
}
];
};
};
}
```
This places the `bulkgen` binary on your `$PATH`. To use a different package build (e.g. from a different system or overlay), set `programs.bulkgen.package`.
The flake also exposes:
- `packages.<system>.bulkgen` — the standalone package, usable without home-manager (e.g. `nix run github:kfickel/bulkgen`)
- `devShells.<system>.default` — development shell with all dependencies
## Environment variables
| Variable | Required for |