From 3f7b650f402adb0c22dc36bd0d170bf31b0cc985 Mon Sep 17 00:00:00 2001 From: Bun Date: Tue, 6 May 2025 05:02:12 -0400 Subject: [PATCH] Update README --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 28e2d6b3..87fdf860 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ ## Nix Systems Thanks for taking a look at my Nix* flake! -While this is primarily organized for my own use, you may find each individual service or config useful to read, reference, learn from, and adapt for your own systems. +This config is primarily organized for my own use, you may find individual services or config useful to read, reference, and adapt for your own systems. ### Installation -You can install this flake from any system with Nix installed, including any ISO. +You can install this flake from any system with the Nix package manager installed, including any official images. +Disko is used to automatically format your drive according to a declared config. Use ``nix --experimental-features "nix-command flakes" run github:nix-community/disko/latest -- --mode destroy,format,mount ./filename.nix`` to format the disk with Disko. -You will want to generate a hardware-config.nix file using ``nixos-generate-config --root ./ --no-filesystems``, and adapt it to fit the format of ``/hosts``, adjusting for your specific system. -After, the install can be finished with ``nixos-install --root /mnt --flake .#host``, where ``host`` is a hostname defined in this flake. +You will likely want to generate a per hardware nix file using ``nixos-generate-config --root ./ --no-filesystems``, and adapt it to fit the format of ``/hosts``, to ensure essential drivers are loaded on boot. +Once formatted and adjusted, NixOS can be installed to the mounted drive with ``nixos-install --root /mnt --flake .#host``, where ``host`` is a hostname defined in this flake. ### Usage -Home-Manager is handled with the system, but can be used on other systems with Nix without root. -A rebuild of a user's home is done with ``nh home switch . -c user``, where user is defined under ``homeConfigurations`` in the flake. +Home-Manager is handled along side the system, but can be used on other systems with Nix without root. +A rebuild of a user's home is done with ``nh home switch . -c user``, where ``user`` is defined under ``homeConfigurations`` in the flake. My config pirmarily uses these tools: -``Niri`` - Window manager / Desktop +``Sway`` - Window manager / Desktop ``ZSH`` - Primary shell ``Foot`` - Terminal emulator ``Rofi`` - App launcher and menu system