From 25b373118a8418c421d977ff87f3bb9b04f03441 Mon Sep 17 00:00:00 2001 From: Emmet Date: Wed, 21 Jun 2023 10:31:09 -0500 Subject: [PATCH] Improved documentation --- flake.nix | 1 + profiles/README.org | 10 ++++++++++ profiles/homelab/README.org | 3 +++ profiles/personal/README.org | 3 +++ profiles/work/README.org | 3 +++ system/README.org | 4 ++++ user/README.org | 2 +- 7 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 profiles/README.org create mode 100644 profiles/homelab/README.org create mode 100644 profiles/personal/README.org create mode 100644 profiles/work/README.org diff --git a/flake.nix b/flake.nix index ed2922d..dc438e8 100644 --- a/flake.nix +++ b/flake.nix @@ -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; }; diff --git a/profiles/README.org b/profiles/README.org new file mode 100644 index 0000000..823abee --- /dev/null +++ b/profiles/README.org @@ -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. diff --git a/profiles/homelab/README.org b/profiles/homelab/README.org new file mode 100644 index 0000000..0e0a4ba --- /dev/null +++ b/profiles/homelab/README.org @@ -0,0 +1,3 @@ +#+title: Homelab Template + +This is a template system configuration to be installed as a homelab/server! diff --git a/profiles/personal/README.org b/profiles/personal/README.org new file mode 100644 index 0000000..556e203 --- /dev/null +++ b/profiles/personal/README.org @@ -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! diff --git a/profiles/work/README.org b/profiles/work/README.org new file mode 100644 index 0000000..3f6d8af --- /dev/null +++ b/profiles/work/README.org @@ -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! diff --git a/system/README.org b/system/README.org index c52db59..4d01cb8 100644 --- a/system/README.org +++ b/system/README.org @@ -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. diff --git a/user/README.org b/user/README.org index 338f09e..a6a3741 100644 --- a/user/README.org +++ b/user/README.org @@ -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]]