commit 0a4c7c667645dd9a3f49638a06b3e5d4cbdd151f
parent 1850590bc3198e7c0189ea843c5ba2b1e09a60e9
Author: breadcat <breadcat@users.noreply.github.com>
Date: Sat, 20 Dec 2025 15:28:23 +0000
Update readme
Diffstat:
| M | readme.md | | | 45 | +++++++++++++++++++++++++++++++++++++-------- |
1 file changed, 37 insertions(+), 8 deletions(-)
diff --git a/readme.md b/readme.md
@@ -1,8 +1,37 @@
-# Nix Configs
-
-An effort to merge [dotfiles](https://github.com/breadcat/dotfiles), [dockerfiles](https://github.com/breadcat/Dockerfiles) and all things in between in a declarative way.
-
-Amend your `variables.nix`, then run:
-```
-sudo nixos-rebuild -I nixos-config=entrypoint.nix switch
-```
+# Nix Configs
+
+An effort to merge my [dotfiles](https://github.com/breadcat/dotfiles), [dockerfiles](https://github.com/breadcat/Dockerfiles) and [ahk-assistant](https://github.com/breadcat/ahk-assistant) in a declarative way.
+
+Amend your `variables.nix`, then run:
+```
+sudo nixos-rebuild -I nixos-config=entrypoint.nix switch
+```
+
+## Machines
+* `arcadia` - Intel NUC HTPC
+* `artemis` - Ampere VPS
+* `atlas` - Gaming workstation
+* `ilias` - Optiplex NAS
+* `minerva` - Thinkpad Laptop
+
+## Notes
+
+### Hostnames
+I'm intentionally avoiding using flakes for this project, so you'll need to set your hostname to one of the above, then run the switch command at the top.
+
+### Filesystems
+Filesystems are mounted via label, not UUID; so you'll want to label your drives before installing:
+```
+nix-shell -p dosfstools
+sudo fatlabel /dev/sda1 NIXBOOT
+sudo e2label /dev/sda2 NIXROOT
+```
+
+### Upgrades
+All `system.stateVersion` are defined at time of install. To upgrade a system, change the channel:
+```
+sudo nix-channel --list
+sudo nix-channel --add https://nixos.org/channels/nixos-25.11 nixos
+sudo nix-channel --update
+```
+The home-manager version is defined in `common/home-manager.nix`.
