From 01668ddee6bb008279e8b064208aa42d34eadfa4 Mon Sep 17 00:00:00 2001 From: oddlama Date: Sun, 2 Jul 2023 00:22:59 +0200 Subject: [PATCH] docs: clarifications --- README.md | 5 ++++- STRUCTURE.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5aff57..b90a554 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,10 @@ but here's a quick breakdown of the what you will find where. `apps/` | runnable actions for flake maintenance `hosts/` | top-level configuration for `` `lib/` | library functions overlayed on top of `nixpkgs.lib` -`modules/` | contains modularized configuration. +`modules/config/` | global configuration for all hosts +`modules/optional/` | optional configuration included by hosts +`modules/meta/` | simplified setup for existing modules and cross-host config +`modules/*/` | classical reusable configuration modules `nix/` | library functions and flake plumbing `pkgs/` | Custom packages and scripts `secrets/` | Global secrets and age identities diff --git a/STRUCTURE.md b/STRUCTURE.md index 5bb9ecb..b3b833a 100644 --- a/STRUCTURE.md +++ b/STRUCTURE.md @@ -32,7 +32,7 @@ Make sure to utilize the github search if you know what you need! Some of these are "meta" in the sense that they depend on their own definitions on multiple hosts (wireguard). These are probably as opinionated as stuff in `modules/config/` but may be a little more general. The `wireguard` module would even be a candidate for extraction to a separate flake, together with the related apps. - - `modules//` regular modules related to , similar structure as in `nixpkgs/nixos/modules` + - `modules/*/` regular modules related to , similar structure as in `nixpkgs/nixos/modules` - `nix/` library functions and flake plumbing - `checks.nix` pre-commit-hooks for this repository