From 3ae586c27244533906bd771c72ad41ea5b2559f8 Mon Sep 17 00:00:00 2001 From: Anthony Rodriguez Date: Tue, 22 Oct 2024 15:08:40 +0200 Subject: [PATCH] hosts: add README --- hosts/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 hosts/README.md diff --git a/hosts/README.md b/hosts/README.md new file mode 100644 index 0000000..fdc1283 --- /dev/null +++ b/hosts/README.md @@ -0,0 +1,25 @@ +# 💻 Hosts + +This directory contains the entry points for different NixOS system configurations. Each host represents a complete system configuration, combining NixOS system settings and Home Manager configurations. + +## Components + +### default.nix + +The `default.nix` file in each host directory serves as the main entry point for the system configuration. It: + +- Sets up NixOS configurations +- Sets up Home Manager configurations +- References host-specific module declarations + +### modules/ + +The `modules/` directory contains host-specific declarations for custom modules that are defined in the flake's `nixosModules` output. This so far only includes global theme / style related declarations. + +## Adding a New Host + +1. Create a new directory for the host +2. Add a `hardware-configuration.nix` generated with `nixos-generate-config` +3. Add a `default.nix` that imports the desired configurations +4. Create host-specific module declarations in the `modules/` subdirectory to customize the global modules as needed +5. Reference the new host in `hosts/default.nix`