Improved documentation for my config

This commit is contained in:
Emmet 2023-06-11 10:26:47 -05:00
parent 4a44c06a43
commit 2615d4d255
5 changed files with 144 additions and 45 deletions

23
system/README.org Normal file
View file

@ -0,0 +1,23 @@
#+title: System-level Nix Modules
#+author: Emmet
** System-level Nix Modules
Separate Nix files can be imported as modules using an import block:
#+BEGIN_SRC nix
imports = [ import1.nix
import2.nix
...
];
#+END_SRC
My system-level Nix modules are organized into this directory:
- [[./hardware-configuration.nix][hardware-configuration]] - Default hardware config generated for my system
- [[./style][style]] - Stylix setup (system-wide base16 theme generation) - Currently broken and needs fixing; last time I tried it doesn't work nicely with home-manager stylix at the same time
** Variables imported from flake.nix
Variables can be imported from [[../flake.nix][flake.nix]] by setting the =specialArgs= block inside the flake (see [[../flake.nix][my flake]] for more details). This allows variables to merely be managed in one place ([[../flake.nix][flake.nix]]) rather than having to manage them in multiple locations.
I currently import the following variables to the system config:
- =myTheme= - base16 theme stored in ../themes to be used
- =myBackgroundUrl= - Direct link to background wallpaper (used for login screen)
- =myBackgroundSha256= - Checksum for background image used when downloading