update readme

This commit is contained in:
xenia 2024-04-23 18:44:21 -04:00
parent eed995d637
commit 3f560c00a3
1 changed files with 11 additions and 0 deletions

View File

@ -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