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