Improved documentation

This commit is contained in:
Emmet 2023-06-21 10:31:09 -05:00
parent f81bab144d
commit 25b373118a
7 changed files with 25 additions and 1 deletions

View file

@ -29,6 +29,7 @@
backgroundSha256Path = "/themes/"+theme+"/backgroundsha256.txt";
backgroundSha256 = builtins.readFile (./. + backgroundSha256Path);
# set pkgs to correct type
pkgs = import nixpkgs {
inherit system;
config = { allowUnfree = true; };

10
profiles/README.org Normal file
View file

@ -0,0 +1,10 @@
#+title: System Profiles
This directory contains various system profiles which can easily be set in [[../flake.nix][my flake.nix]] by setting the =profile= variable. Each profile directory contains a =configuration.nix= for system-level configuration and a =home.nix= for user-level configuration. Setting the =profile= variable in [[../flake.nix][my flake]] will automatically source the correct =configuration.nix= and =home.nix=.
Current profiles I have available are:
- [[./personal][Personal]] - What I would run on a personal laptop/desktop*
- [[./work][Work]] - What I would run on a work laptop/desktop (if they let me bring my own OS :P)
- [[./homelab][Homelab]] - What I would run on a server or homelab
*My [[./personal][personal]] and [[./work][work]] profiles are actually functionally identical (the [[./work][work]] profile is actually imported into the [[./personal][personal]] profile)! The only difference between them is that my [[./personal][personal]] profile has a few extra things like gaming and social apps.

View file

@ -0,0 +1,3 @@
#+title: Homelab Template
This is a template system configuration to be installed as a homelab/server!

View file

@ -0,0 +1,3 @@
#+title: Just chillin'
This is my profile for a personal computer. It is functionally identical to my [[../work]] profile, but includes extra things like games and social apps!

3
profiles/work/README.org Normal file
View file

@ -0,0 +1,3 @@
#+title: No time for games!
This is my =Work= profile, including all the things I need to be efficient for the various hats I wear, and /not/ including distracting things such as games and social apps!

View file

@ -11,7 +11,11 @@ imports = [ import1.nix
My system-level Nix modules are organized into this directory:
- [[./hardware-configuration.nix][hardware-configuration]] - Default hardware config generated for my system
- [[./app][app]] - Necessary system-level configuration to get various apps working
- [[./hardware][hardware]] - Hardware configurations I may need to use
- [[./security][security]] - System-level security stuff
- [[./style][style]] - Stylix setup (system-wide base16 theme generation)
- [[./wm][wm]] - Necessary system-level configuration to get various window managers, wayland compositors, and/or desktop environments working
** 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.

View file

@ -33,7 +33,7 @@ My user-level Nix modules are organized into this directory:
- [[./shell/sh.nix][sh]] - bash and zsh configs
- [[./shell/cli-collection.nix][cli-collection]] - Curated useful CLI utilities
- [[./style][style]] - Stylix setup (system-wide base16 theme generation)
- [[./wm][wm]] - Window manager, compositor, and/or wayland compositor setups
- [[./wm][wm]] - Window manager, compositor, wayland compositor, and/or desktop environment setups
- [[./wm/xmonad][xmonad]]
- [[./wm/picom][picom]]