Skip to content

Commit 30c31ab

Browse files
committed
docs: install.rst + top README catch up to the 2-variant Docker
Both files still showed the old single-variant build.sh example ('./build.sh ... tags uniros:noetic'). Update both to show the default and --slim invocations side-by-side, and add the explicit "if you're already on Ubuntu 20.04, skip Docker" guidance — there's a real cost (GL passthrough + nvidia-container-toolkit / driver compatibility on 20.04 hosts) to going through Docker when the native installer is right there.
1 parent 9a7ca2f commit 30c31ab

2 files changed

Lines changed: 36 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,30 @@ piece-by-piece.
4444

4545
If your host is Ubuntu 22.04 / 24.04, has a GPU with no Ubuntu 20.04
4646
driver (RTX 50-series, etc.), or is Windows with WSL2, the same
47-
stack ships as a Docker image:
47+
stack ships as a Docker image in two variants:
4848

4949
```bash
5050
git clone -b gymnasium https://github.com/ncbdrck/UniROS.git
5151
cd UniROS/docker
52-
./build.sh # tags 'uniros:noetic'
53-
./run.sh # headless
54-
./run_gui.sh # GUI (Gazebo, RViz) via rocker
52+
53+
# Default (CUDA-runtime base, ~16 GB)
54+
./build.sh
55+
./run_gui.sh
56+
57+
# — or — slim (no CUDA in image, ~12 GB; matches the TIAGo pattern)
58+
./build.sh --slim
59+
./run_gui.sh -t uniros:noetic-slim
5560
```
5661

62+
If you're **already running Ubuntu 20.04 natively**, skip Docker and
63+
use the one-shot installer above on the host directly. Native install
64+
is faster, smaller, and avoids GL-passthrough / nvidia-container-toolkit
65+
compatibility quirks that have surfaced on 20.04 hosts with newer
66+
NVIDIA driver branches.
67+
5768
See [`docker/README.md`](docker/README.md) and the
5869
[install guide's Docker section](https://uniros.readthedocs.io/en/latest/guides/install.html#option-c-docker)
59-
for hardware passthrough, GPU notes, and bind-mounting a host
70+
for variant comparison, hardware passthrough, GPU notes, and bind-mounting a host
6071
workspace for active development.
6172

6273

docs/guides/install.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -324,18 +324,32 @@ Option C — Docker
324324

325325
If your host can't run Ubuntu 20.04 natively (modern OEM laptop,
326326
Ubuntu 22.04 / 24.04, a GPU + driver stack with no Ubuntu 20.04
327-
support, or Windows with WSL2), the same stack is available as a
328-
Docker image:
327+
support, or Windows with WSL2), the same stack ships as a Docker
328+
image in two variants:
329329

330330
.. code-block:: bash
331331
332332
git clone -b gymnasium https://github.com/ncbdrck/UniROS.git
333333
cd UniROS/docker
334-
./build.sh # 30–60 min first build; tags 'uniros:noetic'
335-
./run.sh # headless
336-
./run_gui.sh # GUI (Gazebo, RViz) via rocker
337334
338-
See :doc:`docker` for the full Docker reference — when to use it,
335+
# Default (CUDA-runtime base, ~16 GB)
336+
./build.sh
337+
./run_gui.sh
338+
339+
# — or — slim (no CUDA in image, ~12 GB; matches the TIAGo pattern)
340+
./build.sh --slim
341+
./run_gui.sh -t uniros:noetic-slim
342+
343+
.. note::
344+
345+
If you're **already running Ubuntu 20.04 natively**, use Option A
346+
or B above on the host directly — skip Docker. The native path is
347+
faster, smaller, and avoids GL-passthrough / nvidia-container-toolkit
348+
compatibility quirks that have surfaced on 20.04 hosts with newer
349+
NVIDIA driver branches. Docker is for hosts that *can't* install
350+
20.04 natively.
351+
352+
See :doc:`docker` for the full Docker reference — variant comparison,
339353
hardware passthrough (USB and network), GPU, bind-mounting a host
340354
workspace for active development, troubleshooting, and the roadmap
341355
for in-progress features.

0 commit comments

Comments
 (0)