Updated readme's wrt specialArg vars from flake

This commit is contained in:
Emmet 2024-04-14 12:51:44 -05:00
parent 9d7a5edf03
commit c654aa2a4b
2 changed files with 13 additions and 20 deletions

View file

@ -20,14 +20,10 @@ My system-level Nix modules are organized into this directory:
- [[./wm][wm]] - Necessary system-level configuration to get various window managers, wayland compositors, and/or desktop environments working - [[./wm][wm]] - Necessary system-level configuration to get various window managers, wayland compositors, and/or desktop environments working
** Variables imported from flake.nix ** Variables imported from flake.nix
# TODO update this
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. 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: I use this to pass a few attribute sets:
- =username= - Username - =userSettings= - Settings for the normal user (see [[../flake.nix][flake.nix]] for more details)
- =hostname= - Hostname for machine - =systemSettings= - Settings for the system (see [[../flake.nix][flake.nix]] for more details)
- =timezone= - Timezone for machine - =inputs= - Flake inputs (see [[../flake.nix][flake.nix]] for more details)
- =locale= - Locale for machine - =pkgs-stable= - Allows me to include stable versions of packages along with (my default) unstable versions of packages
- =theme= - base16 theme stored in ../themes to be used
- =backgroundUrl= - Direct link to background wallpaper (used for login screen)
- =backgroundSha256= - Checksum for background image used when downloading

View file

@ -31,20 +31,17 @@ My user-level Nix modules are organized into this directory:
- [[./shell/cli-collection.nix][cli-collection]] - Curated useful CLI utilities - [[./shell/cli-collection.nix][cli-collection]] - Curated useful CLI utilities
- [[./style][style]] - Stylix setup (system-wide base16 theme generation) - [[./style][style]] - Stylix setup (system-wide base16 theme generation)
- [[./wm][wm]] - Window manager, compositor, wayland compositor, and/or desktop environment setups - [[./wm][wm]] - Window manager, compositor, wayland compositor, and/or desktop environment setups
- [[./wm/hyprland][hyprland]]
- [[./wm/xmonad][xmonad]] - [[./wm/xmonad][xmonad]]
- [[./wm/picom][picom]] - [[./wm/picom][picom]]
** Variables imported from flake.nix ** Variables imported from flake.nix
# TODO update this
Variables can be imported from [[../flake.nix][flake.nix]] by setting the =extraSpecialArgs= 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. Variables can be imported from [[../flake.nix][flake.nix]] by setting the =extraSpecialArgs= 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: I use this to pass a few attribute sets:
- =username= - Username - =userSettings= - Settings for the normal user (see [[../flake.nix][flake.nix]] for more details)
- =hostname= - Hostname for machine - =systemSettings= - Settings for the system (see [[../flake.nix][flake.nix]] for more details)
- =myHomeDir= - Absolute path to home directory derived from =username= - =inputs= - Flake inputs (see [[../flake.nix][flake.nix]] for more details)
- =email= - Email - =pkgs-stable= - Allows me to include stable versions of packages along with (my default) unstable versions of packages
- =dotfilesDir= - Path to my dotfiles directory on the system - =pkgs-emacs= - Pinned version of nixpkgs I use for Emacs and its dependencies
- =theme= - base16 theme stored in ../themes to be used - =pkgs-kdenlive= - Pinned version of nixpkgs I use for kdenlive
- =themePolarity= - whether theme is =light= or =dark=
- =backgroundUrl= - Direct link to background wallpaper (used for login screen)
- =backgroundSha256= - Checksum for background image used when downloading