rpqt/flocon
rpqt/flocon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor: update readme for file structure

Browse source
This commit is contained in:
Romain Paquet 2026-01-27 14:36:11 +01:00
parent 7062c95697
commit 0f6fc03ad7
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -4,13 +4,15 @@ This repository contains all my system configurations, mostly deployed using Nix
## Structure ## Structure
The file hierarchy is based on the flake's structure, using [flake parts] conventions.
- **clan**: Clan configuration - **clan**: Clan configuration
- **clanServices**: Custom [Clan Services](https://docs.clan.lol/reference/clanServices) - **clanServices**: Custom [Clan Services](https://docs.clan.lol/reference/clanServices)
- **home**: Dotfiles - **home**: Dotfiles
- **home-manager**: [Home Manager] modules - **homeModules**: [Home Manager] modules
- **infra**: [Terranix] files (for Terraform/OpenTofu) - **infra**: [Terranix] files (for Terraform/OpenTofu)
- **machines**: Per-host configurations - **machines**: Per-host configurations
- **modules**: [NixOS] modules - **nixosModules**: [NixOS] modules
- **packages**: Nix packages - **packages**: Nix packages
- **vars**: Encrypted secrets managed by clan - **vars**: Encrypted secrets managed by clan
@ -26,3 +28,4 @@ dotbot -c ./dotbot/windows.yaml -d home
[Home Manager]: https://home-manager.dev [Home Manager]: https://home-manager.dev
[NixOS]: https://nixos.org [NixOS]: https://nixos.org
[Terranix]: https://terranix.org [Terranix]: https://terranix.org
[Flake parts]: https://flake.parts