From cc979b8eb6bdf71363c8656477dac81d47541219 Mon Sep 17 00:00:00 2001 From: spomichter Date: Thu, 19 Feb 2026 12:50:09 +0000 Subject: [PATCH 1/2] docs(readme): nav description, quickstart with real examples, remove dead perception link --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bbc1a2d24e..4551f0b54e 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,11 @@ Our goal is to provide an easy-to-install, modern framework for general robotics

Navigation and Mapping

- ROS and Native
Watch video + SLAM, dynamic obstacle avoidance, route planning, and autonomous exploration — supported on native DimOS and ROS
Watch video

Perception

- Detectors, 3d projections, VLMs, Audio processing
Watch video + Object detection, depth estimation, VLM reasoning, and audio — from camera to understanding @@ -140,11 +140,34 @@ Now install the Python package. Check the [hardware section](#hardware) above to choose the right `extras` and `blueprint` for your platform. -**Use DimOS as a library / UI** +**Quickstart** ```bash -uv pip install dimos[your_hardware_platform] -dimos run your_platform_blueprint +# Install with Unitree support +uv pip install dimos[base,unitree] + +# Replay a recorded Go2 session (no hardware needed) +# NOTE: First run will show a black rerun window while ~2.4 GB downloads from LFS +dimos --replay run unitree-go2 +``` + +```bash +# Install with simulation support +uv pip install dimos[base,unitree,sim] + +# Run Go2 in MuJoCo simulation +export DISPLAY=:1 # Or DISPLAY=:0 if getting GLFW/OpenGL X11 errors +# ignore the warp warnings +dimos --simulation run unitree-go2 + +# Run G1 humanoid in simulation +dimos --simulation run unitree-g1-sim +``` + +```bash +# Control a real robot (Unitree Go2 over WebRTC) +export ROBOT_IP= +dimos run unitree-go2 ``` **Develop DimOS** @@ -159,8 +182,8 @@ source .venv/bin/activate uv sync --all-extras -# Play a recording of unitree go2 run -dimos --replay run unitree-go2 +# Run in simulation +dimos --simulation run unitree-g1-sim ``` ### Step 3 - Profit From c3196d9e0bff0e70bd7ddc0dfb14b12e7bc25e50 Mon Sep 17 00:00:00 2001 From: spomichter Date: Thu, 19 Feb 2026 12:51:53 +0000 Subject: [PATCH 2/2] fix: revert perception description, only remove dead video link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4551f0b54e..c239b34976 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Our goal is to provide an easy-to-install, modern framework for general robotics

Perception

- Object detection, depth estimation, VLM reasoning, and audio — from camera to understanding + Detectors, 3d projections, VLMs, Audio processing