From 3f560c00a39bc78be5f3e70a6739f421cd1415c7 Mon Sep 17 00:00:00 2001 From: xenia Date: Tue, 23 Apr 2024 18:44:21 -0400 Subject: [PATCH] update readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4aa7a04..12e656a 100644 --- a/README.md +++ b/README.md @@ -177,6 +177,17 @@ pkgs.mkNginxServer { } ``` +## development + +structure of this repo +- `default.nix`: the top level NixOS module, which can also be interpreted as a plain nix file + outside of NixOS for access to just the nixpkgs overlay. this contains all definitions for + packages, library functions, and NixOS modules +- `lib/`: library functions (ie functions that get added to the overlay) go here +- `modules/`: NixOS modules go here +- `pkgs/`: packages that get added to the overlay go here +- `support/`: WIP support tools (eg generating documentation) + ## licensing this repository is NOT licensed under a "standard" FOSS license. instead, it uses