docs: point users towards passing in self to buildClan

This commit is contained in:
Michael Hoang
2025-05-27 13:43:59 +10:00
parent a62ac116d8
commit eadd59ff21
2 changed files with 7 additions and 4 deletions

View File

@@ -2,7 +2,7 @@
Managing machine configurations can be done in the following ways: Managing machine configurations can be done in the following ways:
- writing Nix expressions in a `flake.nix` file - writing Nix expressions in a `flake.nix` file
- placing `autoincluded` files into your machine directory - placing configuration files into your machine directory
Clan currently offers the following methods to configure machines: Clan currently offers the following methods to configure machines:
@@ -33,8 +33,8 @@ In the `flake.nix` file:
buildClan { buildClan {
# Set a unique name # Set a unique name
meta.name = "Lobsters"; meta.name = "Lobsters";
# Should usually point to the directory of flake.nix # Necessary for importing external Clan services
directory = ./.; inherit self;
} }
``` ```
@@ -46,6 +46,8 @@ In the `flake.nix` file:
clan = { clan = {
# Set a unique name # Set a unique name
meta.name = "Lobsters"; meta.name = "Lobsters";
# Necessary for importing external Clan services
inherit self;
}; };
``` ```

View File

@@ -1,10 +1,11 @@
{ inputs, ... }: { self, inputs, ... }:
{ {
imports = [ imports = [
inputs.clan.flakeModules.default inputs.clan.flakeModules.default
]; ];
clan = { clan = {
meta.name = "__CHANGE_ME__"; meta.name = "__CHANGE_ME__";
inherit self;
specialArgs = { specialArgs = {
inherit inputs; inherit inputs;
}; };