From d0e46e046409b1a511e19caaa02c016438b7c8e1 Mon Sep 17 00:00:00 2001
From: Aly Raffauf <aly@raffauflabs.com>
Date: Sat, 27 Apr 2024 20:11:14 -0400
Subject: [PATCH] updated README

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 37 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index e614f2c3..af3d4013 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,31 @@
 # nixcfg
+NixOS flake for all of mine + my husband's hosts. Modules for Hyprland, Sway, GNOME, and a variety of Home Lab services running on a mix of nix-native and OCI containers. Uses home-manager for managing dotfiles and disko for automatically partioning drives.
+
+## Rice
 ![](./_img/sway.png)
-![](./_img/hyprland.png)
-![](./_img/gnome.png)
 
 ## Hosts
-| Host    |            lavaridge |               petalburg |               rustboro |                mauville |
-|---------|---------------------:|------------------------:|-----------------------:|------------------------:|
-| Model   |  Framework Laptop 13 |    Lenovo Yoga 9i Gen 8 |         ThinkPad T440p | Custom Mini-ITX Desktop |
-| Display | 13.5" 2256x1504 60Hz | 14" 2880x1800 90hz OLED |     14" 1920x1080 60hz |  34" 3440x1440 160Hz VA |
-| CPU     |      AMD Ryzen 7640U |     Intel Core i7-1360P |    Intel Core i5-4210M |        AMD Ryzen 5 2600 |
-| RAM     |    32GB DDR5-5600Mhz |     16GB LPDDR5-5200Mhz |     16GB DDR3L-1600Mhz |       16GB DDR4-3200Mhz |
-| GPU     |      AMD Radeon 760M |  Intel Iris Xe Graphics | Intel HD Graphics 4600 |      AMD Radeon Rx 6700 |
-| Storage |     1TB Sk hynix P41 |      512GB M.2 PCIe 4.0 |         512GB SATA SSD |        1TB M.2 PCIe 3.0 |
-| OS      |       NixOS Unstable |          NixOS Unstable |         NixOS Unstable |          NixOS Unstable |
-<!-- | Desktop |                GNOME |                   GNOME |             KDE Plasma |                   GNOME | -->
+| Host    | lavaridge            | petalburg               | rustboro               |
+|---------|----------------------|-------------------------|------------------------|
+| Model   | Framework Laptop 13  | Lenovo Yoga 9i Gen 8    | ThinkPad T440p         |
+| Display | 13.5" 2256x1504 60Hz | 14" 2880x1800 90hz OLED | 14" 1920x1080 60hz     |
+| CPU     | AMD Ryzen 7640U      | Intel Core i7-1360P     | Intel Core i5-4210M    |
+| RAM     | 32GB DDR5-5600Mhz    | 16GB LPDDR5-5200Mhz     | 16GB DDR3L-1600Mhz     |
+| GPU     | AMD Radeon 760M      | Intel Iris Xe Graphics  | Intel HD Graphics 4600 |
+| Storage | 1TB Sk hynix P41     | 512GB M.2 PCIe 4.0      | 512GB SATA SSD         |
+| OS      | NixOS Unstable       | NixOS Unstable          | NixOS Unstable         |
+| Desktop | Hyprland             | Sway                    | Sway                   |
+
+| Host    | mossdeep                | fallarbor              | mauville                |
+|---------|-------------------------|------------------------|-------------------------|
+| Model   | Steam Deck OLED         | Framework Laptop 13    | Custom Mini-ITX Desktop |
+| Display | 7.4" 1280x800 90Hz OLED | 13.5" 2256x1504 60Hz   | 34" 3440x1440 160Hz VA  |
+| CPU     | AMD "Sephiroth" APU     | Intel Core i5-1135G7   | AMD Ryzen 5 2600        |
+| RAM     | 16GB LPDDR5 6400 MT/s   | 16GB DDR4-3200Mhz      | 16GB DDR4-3200Mhz       |
+| GPU     | AMD RDNA 2              | Intel Iris Xe Graphics | AMD Radeon Rx 6700      |
+| Storage | 512GB M.2 PCIe SSD      | 512GB M.2 PCIe 3.0     | 1TB M.2 PCIe 3.0        |
+| OS      | NixOS Unstable          | NixOS Unstable         | NixOS Unstable          |
+| Desktop | Hyprland                | Hyprland               | Hyprland                |
 
 ## Home Lab Services
 | Service          | Description                       | Source/Runtime                       | Domain                           |
@@ -30,7 +42,7 @@
 | Ollama           | Runs opensource LLMs.             | nixpkgs                              | Tailnet                          |
 
 ## Deploying to NixOS
-> :red_circle: **READ**: **Do not deploy this flake directly to your machine. It won't work.**
+> :red_circle: **Do not deploy this flake unmodified to your machine. It won't work.**
 > This is my own [NixOS](https://nixos.org/) and [home-manager](https://github.com/nix-community/home-manager) flake for my personal devices.
 > Each hardware-configuration is host-specific. If you fork this repository, replace them with the hardware-configuration.nix that NixOS generates for you.
 
@@ -41,7 +53,17 @@ nix.settings.experimental-features = [ "nix-command" "flakes" ];
 ```
 ### Building Flake
 In order to deploy this Flake on your host, run the following command:
+```console
+sudo nixos-rebuild boot --flake github:alyraffauf/nixcfg#HOST
 ```
-sudo nixos-rebuild boot --flake github:alyraffauf/nixcfg
+Substitute `HOST` for whichever hostname you have chosen. Reboot to apply the flake's configuration for the chosen host.
+
+### Installing from Live USB
+> :red_circle: **This will erase your computer's disk** as specified by the host configuration, installing a fresh copy of NixOS. Backup first!
+
+If you want to install NixOS from this flake, run the following commands, substituting `HOST` with a NixOS configuration specified in `flake.nix`.
+```console
+sudo nix --experimental-features "nix-command flakes" run github:nix-community/disko -- --mode disko --flake github:alyraffauf/nixcfg#HOST
+
+sudo nixos-install --no-root-password --root /mnt --flake github:alyraffauf/nixcfg#HOST
 ```
-Reboot to apply the flake's configuration for the chosen host.