Merge pull request 'docs: point users towards passing in self to buildClan' (#3772) from push-wluozlqruukw into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3772
Reviewed-by: kenji <aks.kenji@protonmail.com>
This commit is contained in:
Michael Hoang
2025-05-27 12:34:27 +00:00
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:
- 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:
@@ -33,8 +33,8 @@ In the `flake.nix` file:
buildClan {
# Set a unique name
meta.name = "Lobsters";
# Should usually point to the directory of flake.nix
directory = ./.;
# Necessary for importing external Clan services
inherit self;
}
```
@@ -46,6 +46,8 @@ In the `flake.nix` file:
clan = {
# Set a unique name
meta.name = "Lobsters";
# Necessary for importing external Clan services
inherit self;
};
```

View File

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