Skip to content

Add docs for how to use CloudXRLauncher #410

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

Open
jiwenc-nv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for how to use CloudXRLauncher #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/source/getting_started/quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ You should see output similar to:
Also take note of the ``source /home/dev/.cloudxr/run/cloudxr.env`` path it mentioned in the
output. You will need to source it in step :ref:`load-cloudxr-environment-variables`.

.. tip::

To embed the CloudXR runtime inside an existing Python application (instead of running it in a
dedicated terminal), or for the full list of environment variables, log locations, and
troubleshooting steps, see :doc:`../references/cloudxr`.

CloudXR Configurations (Optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Table of Contents
references/build
device/index
references/retargeting/index
references/cloudxr
references/mcap_record_replay
references/oob_teleop_control
references/license
Expand Down
Loading
Loading