Update README

This commit is contained in:
Bun 2025-03-21 19:55:01 -04:00
parent 5a56c5ac60
commit 268a455c32

View file

@ -5,22 +5,19 @@ While this is primarily organized for my own use, you may find each individual s
### Installation ### Installation
You can install this flake from any system with Nix installed, including any ISO. You can install this flake from any system with Nix installed, including any ISO.
An initial install will can be done with ``nixos-rebuild switch --flake /etc/nixos/.#host``, where ``host`` is a hostname defined in this flake. You may also have to enable "experimental" features with a flag, such as nix-command and flakes. Use ``sudo 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. 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 --flake /etc/nixos/.#host``, where ``host`` is a hostname defined in this flake.
### Usage ### 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 ``home-manager switch --flake /etc/nixos/.#user``, as defined under ``homeConfigurations`` in the flake. 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 ``home-manager switch --flake /etc/nixos/.#user``, as defined under ``homeConfigurations`` in the flake.
My config uses these tools: My config pirmarily uses these tools:
``Sway`` - Window manager / Desktop ``Niri`` - Window manager / Desktop
``ZSH`` - Primary shell ``ZSH`` - Primary shell
``Foot`` - Terminal emulator ``Foot`` - Terminal emulator
``Rofi`` - App launcher and menu system ``Rofi`` - App launcher and menu system
Shell aliases are defined in the home manager config to rebuild the Nix system, they are as follows:
`flakedate` - Update the flake.lock, which renews the sources of nixpkgs. This is needed to update the system.
`nhs` - An alias for nh to switch the system profile.
My server's config heavily references a git-crypt protected secrets file. These will have to be adapted and rewritten if anyone is to use my config directly. My server's config heavily references a git-crypt protected secrets file. These will have to be adapted and rewritten if anyone is to use my config directly.
For my use, unlocking secrets can be done with this command: For my use, unlocking secrets can be done with this command:
``gpg --pinentry-mode loopback --decrypt local.key.asc | git-crypt unlock -`` ``gpg --pinentry-mode loopback --decrypt local.key.asc | git-crypt unlock -``