diff options
| -rw-r--r-- | modules/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 00000000..5d62d3ac --- /dev/null +++ b/modules/README.md @@ -0,0 +1,34 @@ +This directory contains various NixOS modules. + +If you add a module here, make sure that you define all options using a +`vuizvui.*` namespace, so that the documentation is generated and you don't +clash with modules from upstream [nixpkgs](https://github.com/NixOS/nixpkgs). + +For writing modules, make sure to categorize them accordingly: + +<table> + <tr> + <th>profiles</th> + <td>Options for a specific domain (like for example + `desktop`, `router`, `music`, ...) + </td> + </tr> + <tr> + <th>programs</th> + <td>Program-specific configuration options</td> + </tr> + <tr> + <th>services</th> + <td>Modules that implement systemd services</td> + </tr> + <tr> + <th>tasks</th> + <td>Various one-shot services</td> + </tr> +</table> + +If a module is highly specific for your own configuration, use the same +categories but put them under `user/$category/$module`. + +Don't forget to add your module to the list module-list.nix, but make sure you +have options in place to disable them by default. |