From 4e23ffa6c49973dcc43f1b7760ba0c95b30cf4b2 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Thu, 22 Jun 2023 18:04:02 +0800 Subject: [PATCH] docs: update project setup notes With the right configuration alongside system --- README.adoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 595fa0be..9cb63421 100644 --- a/README.adoc +++ b/README.adoc @@ -92,7 +92,7 @@ As a helpful summary, here's what my flake should contain sorting from the most * `overlays` contains the overlay for extending nixpkgs with my packages. If you want to use my packages alongside the nixpkgs attribute then this is what you're looking for. -* `homeManagerModules` are where my link:./modules/home-manager[custom home-manager modules] to be exported. +* `homeModules` are where my link:./modules/home-manager[custom home-manager modules] to be exported. footnote:[This is more useful than my NixOS modules.] * `nixosModules` are composed from NixOS modules defined in link:./modules/nixos[`./modules/nixos`]. @@ -110,7 +110,7 @@ A few examples include: * `devShells` from link:./shells/[my custom environments]. Similar to `homeManagerConfigurations`, you can easily use it outside of NixOS. -* `homeManagerConfigurations` contains my various link:https://github.com/nix-community/home-manager[home-manager] configurations from link:./users/home-manager/[`./users/home-manager/`]. +* `homeConfigurations` contains my various link:https://github.com/nix-community/home-manager[home-manager] configurations from link:./users/home-manager/[`./users/home-manager/`]. The neat thing about it is you can easily install it in a non-NixOS Linux distro. * `deploy` are nodes to be deployed by link:https://github.com/serokell/deploy-rs[deploy-rs]. @@ -195,9 +195,14 @@ nixos-config ├── default.nix ├── flake.lock ├── flake.nix +├── images.toml └── README.adoc ---- +One of the more notable files here when first start looking is the link:./images.toml[`./images.toml`] file where it contains a description of the images. +The data is then used for certain functions in the flake definition file (i.e., `flake.nix`). +The data can contain from what image output format it is intended to be deployed (most likely used anyways), the nixpkgs channel to be used, and its system (e.g., `x86_64-linux`). + Most of the said folders are related to a flake output attribute, see <> for more details. * link:./hosts/[`./hosts/`] contain machine-specific configuration.