modules/README: init

Explain the purpose and usage of this new directory.
This commit is contained in:
Robert Hensing
2025-08-10 14:08:04 +02:00
parent 79748defd7
commit 1cafa1fd7e

9
modules/README.md Normal file
View File

@@ -0,0 +1,9 @@
# `<nixpkgs>/modules`
This directory hosts subdirectories representing each module [class](https://nixos.org/manual/nixpkgs/stable/#module-system-lib-evalModules-param-class) for which the `nixpkgs` repository has user-importable modules.
Exceptions:
- `_class = "nixos";` modules go in the `<nixpkgs>/nixos/modules` tree
- modules whose only purpose is to test code in this repository
The emphasis is on _importable_ modules, i.e. ones that aren't inherent to and built into the Module System application.