diff --git a/README.md b/README.md index 6632f76..ee26a1c 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,16 @@ Thanks for taking a look at my Nix* configs! While this is primarily organized for my use only, you may find each individual service file or user config to be a good starting point, or something to take and adapt into your own config. ### Installation -Installing any of my flakes onto a system should be done after any initial install. I would opt to do a minimal install, but this is up to you. -After installing NixOS, backup your hardware-config.nix file, so you can adapt it to fit the format of ``nixos/hardware/machines``, then adjusting the other referenced files in the flake.nix file to reference your specific computer. +Installing any of my flakes onto a system should be done after any initial install. I would opt to do a minimal install, but this is up to you. After installing NixOS, backup your hardware-config.nix file, so you can adapt it to fit the format of ``nixos/hardware/machines``, then adjusting the other referenced files in the flake.nix file to reference your specific computer. -An initial install will have to be ran as ``nixos-rebuild switch --flake /etc/nixos/.#HOSTNAME``, where HOSTNAME is a hostname defined in your flake. You may also have to enable "experimental" features with a flag, such as nix-command and flakes. -Home-Manager is handled separately, despite being in the same folder. A rebuild of a user's home would have to be done with ``home-manager switch --flake /etc/nixos``. This will pull the config as defined in the flake as ``USER@HOSTNAME``, where USER is the user running the ``home-manager`` command. +An initial install will have to be ran as ``nixos-rebuild switch --flake /etc/nixos/.#HOSTNAME``, where HOSTNAME is a hostname defined in your flake. You may also have to enable "experimental" features with a flag, such as nix-command and flakes. Home-Manager is handled separately, despite being in the same folder. A rebuild of a user's home would have to be done with ``home-manager switch --flake /etc/nixos``. This will pull the config as defined in the flake as ``USER@HOSTNAME``, where USER is the user running the ``home-manager`` command. ### Usage My config uses these tools: -Sway - Window manager / Desktop -Foot - Terminal emulator -Rofi - App launcher and menu system -ZSH - Primary shell +`Sway` - Window manager / Desktop +`Foot` - Terminal emulator +`Rofi` - App launcher and menu system +`ZSH` - Primary shell I have made shell aliases in ZSH for rebuilding the system. They are as follows: `flakedate` - Update the flake.lock, which renews the sources of nixpkgs. This is needed to update the system. @@ -28,6 +26,12 @@ My config heavily references a gnupg-protected secrets file. These will have to For my use, unlocking secrets can be done with this command: ``gpg --pinentry-mode loopback --decrypt local.key.asc | git-crypt unlock -`` +### Credits +Without the help of heavy inspiration, I would not have been able to learn and get up and running nearly as quickly. My most heavily borrowed configs are as follows: +[CloudyChris' nix-starter-configs fork](https://github.com/CloudyChris/NixOsConfig), the very initial base of my conversion to flakes. +[WillPower3309's personal flake](https://github.com/WillPower3309/swayfx) for being a pleasure in the SwayFX Discord and having a really nice flake.nix file I borrowed from. +[Jules Sommer's minimal flake](https://github.com/WillPower3309/swayfx) for giving me a good basis for writing individual files and repeatedly helping me throughout the entire process. + Made with love ❤️ ![image](./preview.png)