Skip to content

docs(readme): nav description, quickstart with real examples, remove dead perception link #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spomichter merged 2 commits into from
Feb 19, 2026
Merged

docs(readme): nav description, quickstart with real examples, remove dead perception link #1301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc979b8
docs(readme): nav description, quickstart with real examples, remove …
spomichter Feb 19, 2026
c3196d9
fix: revert perception description, only remove dead video link
spomichter Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ Our goal is to provide an easy-to-install, modern framework for general robotics
<tr>
<td align="center" width="50%">
<h3><a href="docs/capabilities/navigation/readme.md">Navigation and Mapping</a></h3>
ROS and Native<br><a href="https://x.com/stash_pomichter/status/2010471593806545367">Watch video</a>
SLAM, dynamic obstacle avoidance, route planning, and autonomous exploration — supported on native DimOS and ROS<br><a href="https://x.com/stash_pomichter/status/2010471593806545367">Watch video</a>
</td>
<td align="center" width="50%">
<h3><a href="docs/capabilities/perception/readme.md">Perception</a></h3>
Detectors, 3d projections, VLMs, Audio processing<br><a href="#">Watch video</a>
Detectors, 3d projections, VLMs, Audio processing
</td>
</tr>
<tr>
Expand Down Expand Up @@ -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=<YOUR_ROBOT_IP>
dimos run unitree-go2
```

**Develop DimOS**
Expand All @@ -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
Expand Down
Loading