diff --git a/README.md b/README.md index 899b255..8e7d9a1 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,6 @@ This flake serves as a monorepo for my systems (using IaC), dotfiles, and script This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation. The list of generated files are: - [docs/cheatsheet.md](docs/cheatsheet.md) -- [README.md](README.md) \ No newline at end of file +- [README.md](README.md) +## Structure +The system configurations are defined in [`flake.hostSpec`](nix/hostSpec.nix). diff --git a/nix/flake-parts/files/readme.nix b/nix/flake-parts/files/readme.nix index d17959a..b129f3f 100644 --- a/nix/flake-parts/files/readme.nix +++ b/nix/flake-parts/files/readme.nix @@ -1,21 +1,25 @@ -{ config, lib, ... }: -let - inherit (lib) singleton; -in +{ config, ... }: { text.readme = { heading = "Pantheon"; - description = '' - This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts. - ''; + description = # markdown + '' + This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts. + ''; + parts."Structure" = # markdown + '' + The system configurations are defined in [`flake.hostSpec`](nix/hostSpec.nix). + ''; }; perSystem = { pkgs, ... }: { - files.files = singleton { - path_ = "README.md"; - drv = pkgs.writeText "README.md" config.text.readme; - }; + files.files = [ + { + path_ = "README.md"; + drv = pkgs.writeText "README.md" config.text.readme; + } + ]; }; }