From 0511bf4efd0c7b3373ac32281f7d8052f54e5d93 Mon Sep 17 00:00:00 2001 From: Anthony Rodriguez Date: Tue, 22 Oct 2024 02:00:07 +0200 Subject: [PATCH] repo: update README (explain configuration and minor fixes) --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e2d199e..295c0a0 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,22 @@ Additionally using a lot of other software you can find in the configuration fil # 🛠️ Structure -| Name | Description | -| ------------------- | ------------------------------------------------- | -| [home](home/) | Home manager configuration | -| [hosts](hosts/) | Host-specific (entry-points of the configuration) | -| [lib](lib/) | Helper functions | -| [modules](modules/) | NixOS modules | -| [system](system/) | NixOS configuration | +| Name | Description | +| ------------------- | -------------------------- | +| [home](home/) | Home manager configuration | +| [hosts](hosts/) | Host-specific | +| [lib](lib/) | Helper functions | +| [modules](modules/) | NixOS modules | +| [system](system/) | NixOS configuration | + +My configuration is structured based on the following principles: + +1. Hosts should be the main entry points and outputs. +2. Abstractions should be avoided as much as possible. + +The bulk of the configuration can be found either in [home](home/) or [system](system/), which declares most of my programs, with some extra Nix code in [lib](lib/) and custom [modules](modules/), mostly for convenience and to provide a way to globally set styles and themes for now. + +My hosts can then pick and choose the programs and configurations that they need from the other directories. If the need arises for a more modular setup for a specific piece of software (ie. having different flavors of Firefox per host), I will write a custom module for it. This helps to avoid unnecessarily abstracting my configuration, as I don't find it necessary for the most part, and I would also like it to remain as simple as possible. # 👥 Credits @@ -29,4 +38,4 @@ People / repositories I have copied / learned from: - [fufexan/dotfiles](https://github.com/fufexan/dotfiles) for the configuration structure - [jacekpoz/nixos](https://git.jacekpoz.pl/poz/niksos) for learning how NixOS modules work -Some bits have also been borrowed from within the configuration, and credit has been given when its due. +Some bits have also been borrowed from within the configuration, and credit has been given where its due.