toki/aether
1
0
Fork 0
Code Issues Pull requests Activity

docs: document nixosModules.aether output

Browse source
This commit is contained in:
Kiana Sheibani 2024-11-20 02:36:49 -05:00
parent bb8f338c68
commit 1f4b816ffd
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -33,8 +33,9 @@ each provide different functionality. These are stored in the `modules/` directo
## Deployment ## Deployment
Aether is designed to separate individual machine details from the abstract Aether is designed to separate individual machine details from the abstract
specification of the system, allowing for deployment to several different specification of the system, allowing for its code to be used for many
types of system. This is handled using *deployments* in the `deploy/` directory. different types of system. This is handled using *deployments* in the
`deploy/` directory.
Currently, I deploy Aether physically to a Currently, I deploy Aether physically to a
[Raspberry Pi 5](https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi_5) [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 Any number of modules can be activated at once, and the special
deployment will cause issues, so that should be avoided. `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 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 module has options, they can be found in the `options.nix` file inside the