From 1f4b816ffdad8ab9b29bdc21484117f0cb6c6e84 Mon Sep 17 00:00:00 2001 From: Kiana Sheibani Date: Wed, 20 Nov 2024 02:36:49 -0500 Subject: [PATCH] docs: document `nixosModules.aether` output --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 07c972a..c8bac51 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,9 @@ each provide different functionality. These are stored in the `modules/` directo ## Deployment Aether is designed to separate individual machine details from the abstract -specification of the system, allowing for deployment to several different -types of system. This is handled using *deployments* in the `deploy/` directory. +specification of the system, allowing for its code to be used for many +different types of system. This is handled using *deployments* in the +`deploy/` directory. Currently, I deploy Aether physically to a [Raspberry Pi 5](https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi_5) @@ -73,8 +74,10 @@ to your `imports`: } ``` -Any number of modules can be activated at once, but activating more than one -deployment will cause issues, so that should be avoided. +Any number of modules can be activated at once, and the special +`nixosModules.aether` output can be used to refer to every module at once. +Activating more than one deployment will cause issues, so that should be +avoided. Some modules have options that can be used to configure their effects. If a module has options, they can be found in the `options.nix` file inside the