From 0f6fc03ad7241cc6f5c7163d3c1e1b642c1582a2 Mon Sep 17 00:00:00 2001 From: Romain Paquet Date: Tue, 27 Jan 2026 14:36:11 +0100 Subject: [PATCH] refactor: update readme for file structure --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d8c1f8c..908c269 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,15 @@ This repository contains all my system configurations, mostly deployed using Nix ## Structure +The file hierarchy is based on the flake's structure, using [flake parts] conventions. + - **clan**: Clan configuration - **clanServices**: Custom [Clan Services](https://docs.clan.lol/reference/clanServices) - **home**: Dotfiles -- **home-manager**: [Home Manager] modules +- **homeModules**: [Home Manager] modules - **infra**: [Terranix] files (for Terraform/OpenTofu) - **machines**: Per-host configurations -- **modules**: [NixOS] modules +- **nixosModules**: [NixOS] modules - **packages**: Nix packages - **vars**: Encrypted secrets managed by clan @@ -26,3 +28,4 @@ dotbot -c ./dotbot/windows.yaml -d home [Home Manager]: https://home-manager.dev [NixOS]: https://nixos.org [Terranix]: https://terranix.org +[Flake parts]: https://flake.parts