From bf8661762c02e3372ad7f98697e3f0864cce3f00 Mon Sep 17 00:00:00 2001 From: Christoph Urlacher Date: Tue, 4 Jun 2024 22:34:19 +0200 Subject: [PATCH] Readme: Update readme --- README.md | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index cefe3c79..a6a9f843 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,40 @@ # NixOS Configuration -This is my modular NixOS configuration, using Hyprland for a lightweight desktop. +Modular NixOS configuration, using Hyprland for a lightweight desktop. ![](Foggy-Lake.png) -To install, run ``nixos-rebuild`` with the ``--flake`` parameter from the ``NixFlake`` directory: ``nixos-rebuild switch --flake .#nixinator``. +To install, run `nixos-rebuild` with the `--flake` parameter from the `NixFlake` directory: `nixos-rebuild switch --flake .#nixinator`. ## NixFlake/system -This folder contains all the system configurations. +Contains all the system configurations. -- There is a common configuration used for all systems: ``NixFlake/system/default.nix`` -- Every system has its own special configuration: ``NixFlake/system//default.nix`` -- System modules are located in ``NixFlake/system/modules`` +- There is a common configuration used for all systems: `NixFlake/system/default.nix` +- Every system has its own special configuration: `NixFlake/system//default.nix` +- System modules are located in `NixFlake/system/modules` -When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported. +When creating a NixOS configuration inside the `NixFlake/flake.nix` the common configuration is imported. Because the hostname is propagated to the common configuration, it can import the host-specific config by itself. ## NixFlake/home -This folder contains all the home-manager configurations. +Contains all the home-manager configurations. -- There is a common configuration for each user: ``NixFlake/home//default.nix`` -- There is a configuration for a single system of this user: ``NixFlake/home///default.nix`` -- Home-Manager modules are located in ``NixFlake/home/modules`` +- There is a common configuration for each user: `NixFlake/home//default.nix` +- There is a configuration for a single system of this user: `NixFlake/home///default.nix` +- Home-Manager modules are located in `NixFlake/home/modules` -When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported. +When creating a NixOS configuration inside the `NixFlake/flake.nix` the common configuration is imported. Because the hostname is propagated to the common configuration, it can import the host-specific config by itself. ## NixFlake/derivations -This folder contains all the stuff I packaged. -Each derivation is loaded into ``NixFlake/derivations/default.nix``. +Contains all the stuff I packaged. +Each derivation is loaded into `NixFlake/derivations/default.nix`. ## NixFlake/overlays -This folder contains (not at the moment) all overlays. -The ``NixFlake/overlays/default.nix`` imports all of the overlays and all of the derivations. -It is then imported by the toplevel ``NixFlake/flake.nix``, to make everything available to the system/home configurations. - -## NixFlake/docs - -This folder contains automatically generated static documentation sites for my Home-Manager modules. +Contains (not at the moment) all overlays. +The `NixFlake/overlays/default.nix` imports all of the overlays and all of the derivations. +It is then imported by the toplevel `NixFlake/flake.nix`, to make everything available to the system/home configurations.