From bc85ec43282bf5376e43bee5626bac19bf976cf6 Mon Sep 17 00:00:00 2001 From: Tyler Beckman Date: Fri, 22 Nov 2024 23:36:12 +0000 Subject: [PATCH] Add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae83289 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Ty's NixOS Configuration + +## Config Setup + +The three main parts of my config are the `home-manager/`, `hosts/`, and `packages/` folders. + +### Home manager + +This folder handles everything user-scope related, including most of my installed packages. I try and keep most configuration isolated to the user scope for simplicity and isolation. The main entrypoint for this configuration is in `home-manager/`, but all the real configuration is located in `home-manager/modules` for organizational purposes. Packages installed in the user scope are located in `home-manager/modules/packages.nix`, and everything else is largely configuration for those programs. This also contains KDE Plasma configuration using the https://github.com/nix-community/plasma-manager module for home-manager, to configure the desktop environment and some associated KDE programs - this is largely mixed with the other home-manager options, that might change soon. + +### Hosts + +This folder contains sub-folders for each of my NixOS hosts, of which there is only one for now (my laptop). Each has a `default.nix` entrypoint and the rest of the configuration is kept in a `modules` folder, just like the home-manager configuration. This isn't yet abstracted and easily re-usable for new hosts (I have no need for it given I only have one NixOS install), but might be in the future. + +### Packages + +This folder contains all of my personally-packaged