From 2cbe41f0315fcc2b916358835ef5c433bb1c89b0 Mon Sep 17 00:00:00 2001 From: peteryuqin Date: Wed, 25 Mar 2026 14:42:34 -0400 Subject: [PATCH] docs: add macOS first-run prerequisites to quick start Signed-off-by: peteryuqin --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 38bdb4c233..2d7ecbaf81 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,25 @@ The sandbox image is approximately 2.4 GB compressed. During image push, the Doc | macOS | Podman | Not supported yet. NemoClaw currently depends on OpenShell support for Podman on macOS. | | Windows WSL | Docker Desktop (WSL backend) | Supported target path | +#### macOS first-run checklist + +On a fresh macOS machine, install the prerequisites in this order: + +1. Install Xcode Command Line Tools: + + ```bash + xcode-select --install + ``` + +2. Install and start a supported container runtime: + - Docker Desktop + - Colima +3. Run the NemoClaw installer. + +This avoids the two most common first-run failures on macOS: +- missing developer tools needed by the installer and Node.js toolchain +- Docker connection errors when no supported container runtime is installed or running + > **💡 Tip** > > For DGX Spark, follow the [DGX Spark setup guide](https://github.com/NVIDIA/NemoClaw/blob/main/spark-install.md). It covers Spark-specific prerequisites, such as cgroup v2 and Docker configuration, before running the standard installer.