init

README.md

@@ -0,0 +1,45 @@
+# ZED Playground
+
+This repo provides a Docker Compose setup and Dev Container config based on
+`stereolabs/zed:5.1-gl-devel-cuda12.8-ubuntu24.04`.
+
+## Prerequisites
+
+- Docker + Docker Compose v2
+- NVIDIA Container Toolkit (GPU support)
+- ZED camera connected via USB (optional)
+
+If you use GUI apps inside the container, you need X11 access from the host.
+
+## Quick Start (Docker Compose)
+
+1) Allow local X11 access for root:
+
+```bash
+xhost +local:root
+```
+
+2) Start the container:
+
+```bash
+docker compose up
+```
+
+3) Open a shell in the running container:
+
+```bash
+docker compose exec zed bash
+```
+
+## Dev Container (VS Code / compatible)
+
+1) Open this folder in a Dev Container-capable editor.
+2) It will use `.devcontainer/devcontainer.json` and `docker-compose.yml`.
+
+## Notes
+
+- If you are on Wayland, X11 forwarding may require XWayland. If GUI apps do
+  not appear, log into an X11 session or enable XWayland.
+- USB devices are passed through via `/dev/bus/usb` and the container runs
+  `privileged` for camera access.
+- The workspace is mounted at `/workspaces/zed-playground`.