Skip to content
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.

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

Docs/add zenoh doc and disclaimer to readme #587

Merged
merged 7 commits into from
Feb 28, 2025
Merged
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ The following flags may be useful for extra functionality when running the image
| `--runtime nvidia` + `--gpus all` | Use the [NVIDIA Container Runtime](https://developer.nvidia.com/container-runtime) to run the container with GPU acceleration |
| `-e DISPLAY` | Bind your display to the container in order to run GUI apps. Note that you will need to allow the Docker container to connect to your X11 server, which can be done in a number of ways ranging from disabling X11 authentication entirely, or by allowing the Docker daemon specifically to access your display server. |
| `--network host` | Use the host network directly. May help resolve issues connecting to Spot Wifi |
| `--build-arg EXPERIMENTAL_ZENOH_RMW=TRUE` | Enable experimental rmw_zenoh middleware. May result in issues we cannot address. |

### Experimental - RMW ZENOH Middleware

**Disclaimer:** The RMW ZENOH middleware is now available for installation with the driver. Please note that this feature is currently under experimental testing and may result in issues that we cannot address. To use the zenoh implementation, please refer to the [rmw_zenoh documentation](https://github.com/ros2/rmw_zenoh).


# Packages
Expand Down
Loading