From 238f5d6e9a11e35bc81f502935131e6a3029593d Mon Sep 17 00:00:00 2001 From: pagedMov Date: Wed, 6 Nov 2024 15:04:19 -0500 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b55cfe..fd7d68f 100755 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ Special thanks to Frost-Phoenix, this config started out as a fork of his dots. [Check out his config here](https://github.com/Frost-Phoenix/nixos-config/tree/catppuccin) -Take whatever you like, just know that the hardware configurations in my hosts folder won't work on your machine : ) -My dots are written 100% in Nix so if you bring your own hardware-configuration.nix, these should work on any machine out of the box. - -If you are on NixOS and have flakes enabled, you can just clone the repo and run sudo nixos-rebuild switch --flake /path/to/this-repo (again, just make sure you don't use my hardware configuration on your machine) ## Gallery @@ -41,6 +37,18 @@ The 'Xenon' config is my server configuration and is highly unlikely to be of us This config uses custom modules for the home-manager and system configurations. Basically every part of the configuration can be toggled using an option, and some configs have extra options as well. All of the options declared in these modules can be found in the documentation under docs/options +# Installation + +If you are on NixOS and have flakes enabled, you can just follow these steps: + + 1. Clone the repo to a directory + + 2. Run nixos-generate-config --show-hardware-config > hardware.nix to get a hardware config + + 3. Move the hardware config to the folder of the host you want to use + + 4. Run sudo nixos-rebuild switch --flake /path/to/flake#host where "host" is the name of the config you want to use + ## Scripts ```chpaper``` - opens a fzf window with filenames and previews of images in $FLAKEPATH/assets/wallpapers. Picking one replaces the existing wallpaper path in $FLAKEPATH/flake.nix with the one you chose.