From a935b875a8fe541697cdd1875666df4b0b7d6fda Mon Sep 17 00:00:00 2001
From: Youwen Wu <38934577+youwen5@users.noreply.github.com>
Date: Wed, 7 Aug 2024 16:34:10 -0700
Subject: [PATCH] Update README.md

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 1ed32f3..b1729c2 100755
--- a/README.md
+++ b/README.md
@@ -25,6 +25,16 @@ liminalOS comes with the Nix package manager (nobody said you need a _unique_ pa
 
 No.
 
+## Hosts
+
+The modules in liminalOS are designed to be utilized by a wide variety of machine configurations, including via nix-darwin on macOS. To that end, modules are organized by operating system (darwin vs. linux), architecture (x86_64 vs. aarch-64), and form factor (desktop vs laptop). Anything that is agnostic of these distinctions is considered a "common module" and allows configuration to be shared between the various host types. This generally includes core programs like CLI tools, the window manager, etc.
+
+The [flake.nix](/flake.nix) currently contains configuration for three hosts:
+
+- "callisto": a Macbook Pro M1 (2021) running under Asahi Linux. Imports the laptop module sets as well as the core NixOS module sets.
+- "demeter": a custom desktop with an i7-13700KF and RTX 4080. Imports the desktop module, the core NixOS modules, and additionally the gaming module.
+- "phobos": Macbook Pro M1 (2021) running macOS with nix-darwin. Imports the core home-manager module as well as some darwin-specific modules for window managers and the like.
+
 [^1]: also known as GNU/Linux, GNU+Linux, Freedesktop/systemd/musl/busybox Linux, Linux+friends, etc
 
 [^2]: disclaimer: this is unfortunately not actually how the converse works. A => B does not necessarily imply B => A. I hope this satiates the rigor-hungry mathematicians reading.