---
orphan: true
---

# OmniNav 文档

<p align="center">
  <img src="../_static/logo.png" alt="OmniNav" width="220">
</p>

<div class="omninav-hero">

OmniNav 是面向具身智能的导航仿真平台，在通用导航底座上强调巡检任务闭环。

- 通用导航任务：PointNav / ObjectNav / Waypoint
- 巡检任务链路与评测
- 复杂场景验证与 ROS2/Nav2 集成

</div>

## 快速开始

1. 安装： [INSTALL.md](https://github.com/Royalvice/OmniNav/blob/main/INSTALL.md)
2. 新手 GUI： [examples/getting_started/run_getting_started.py](https://github.com/Royalvice/OmniNav/blob/main/examples/getting_started/run_getting_started.py)
3. ROS2 快速指南： [examples/ros2/omninav_ros2_examples/README.md](https://github.com/Royalvice/OmniNav/blob/main/examples/ros2/omninav_ros2_examples/README.md)

::::{grid} 2
:gutter: 2

:::{grid-item-card} 🚀 Getting Started
:link: getting_started/index
:link-type: doc
安装、首次运行、示例目录与 ROS2/Nav2 指引。
:::

:::{grid-item-card} 📚 API 与参考
:link: api_reference/index
:link-type: doc
核心运行时、接口、规划算法、任务评测、配置与示例、更新记录与贡献说明。
:::

::::

## Language

- English: [Switch to English docs](../index)
- 中文（当前）

```{toctree}
:maxdepth: 2

getting_started/index
api_reference/index
```