forked from clan/clan-core
Docs: rename clanName to just name
This commit is contained in:
parent
39ec23bd31
commit
241cca5b70
@ -4,14 +4,14 @@
|
||||
|
||||
In the `flake.nix` file:
|
||||
|
||||
- [x] set a unique `clanName`.
|
||||
- [x] set a unique `name`.
|
||||
|
||||
=== "**buildClan**"
|
||||
|
||||
```nix title="clan-core.lib.buildClan"
|
||||
buildClan {
|
||||
# Set a unique name
|
||||
clanName = "Lobsters";
|
||||
meta.name = "Lobsters";
|
||||
# Should usually point to the directory of flake.nix
|
||||
directory = ./.;
|
||||
|
||||
@ -31,7 +31,7 @@ In the `flake.nix` file:
|
||||
```nix title="clan-core.flakeModules.default"
|
||||
clan = {
|
||||
# Set a unique name
|
||||
clanName = "Lobsters";
|
||||
meta.name = "Lobsters";
|
||||
|
||||
machines = {
|
||||
jon = {
|
||||
|
@ -63,7 +63,7 @@ Below is a guide on how to structure this in your flake.nix:
|
||||
# Define your clan
|
||||
clan = {
|
||||
# Clan wide settings. (Required)
|
||||
clanName = ""; # Ensure to choose a unique name.
|
||||
meta.name = ""; # Ensure to choose a unique name.
|
||||
|
||||
machines = {
|
||||
jon = {
|
||||
|
@ -31,7 +31,7 @@
|
||||
{ ... }:
|
||||
{
|
||||
clan = {
|
||||
# meta.name = "clan-core";
|
||||
meta.name = "clan-core";
|
||||
directory = self;
|
||||
};
|
||||
systems = [
|
||||
|
@ -10,7 +10,7 @@
|
||||
let
|
||||
clan = clan-core.lib.buildClan {
|
||||
directory = self;
|
||||
clanName = "test_flake_with_core";
|
||||
meta.name = "test_flake_with_core";
|
||||
machines = {
|
||||
vm1 =
|
||||
{ lib, ... }:
|
||||
|
@ -10,7 +10,7 @@
|
||||
let
|
||||
clan = clan-core.lib.buildClan {
|
||||
directory = self;
|
||||
clanName = "test_flake_with_core_and_pass";
|
||||
meta.name = "test_flake_with_core_and_pass";
|
||||
machines = {
|
||||
vm1 =
|
||||
{ lib, ... }:
|
||||
|
@ -10,7 +10,7 @@
|
||||
let
|
||||
clan = clan-core.lib.buildClan {
|
||||
directory = self;
|
||||
clanName = "test_flake_with_core_dynamic_machines";
|
||||
meta.name = "test_flake_with_core_dynamic_machines";
|
||||
machines =
|
||||
let
|
||||
machineModules = builtins.readDir (self + "/machines");
|
||||
|
Loading…
Reference in New Issue
Block a user