Skip to content

DOC: Update README and DeveloperGuide to document OpenXR backend support#172

Merged
jcfr merged 1 commit intoKitwareMedical:masterfrom
jcfr:update-readme-2
Mar 4, 2024
Merged

DOC: Update README and DeveloperGuide to document OpenXR backend support#172
jcfr merged 1 commit intoKitwareMedical:masterfrom
jcfr:update-readme-2

Conversation

@jcfr
Copy link
Contributor

@jcfr jcfr commented Mar 4, 2024

In the README:

  • Revise the top-level and Setup sections to reflect OpenXR support.
  • Update existing headset setup instructions to cover both OpenXR and OpenVR setups, with OpenXR being enabled by default. Added a note at the end of the section explaining how to enable OpenVR support.
  • Add new sections for "Hololens 2" and "Meta Quest" headsets
  • Add entries for "Supported headsets" and "Supported XR modality" to each headset section
  • Add "How to use hand interaction" section
  • Update the Contributors section to acknowledge @LucasGandel and @sankhesh.

In the DeveloperGuide:

  • Remove obsolete build instructions.
  • Update Python snippet.
  • Add references to the documentation of associated VTK modules.
  • Add the "Mapping of Controller Action to VTK event" section.

In the README:
- Revise the top-level and Setup sections to reflect OpenXR support.
- Update existing headset setup instructions to cover both OpenXR and OpenVR setups, with OpenXR being enabled by default. Added a note at the end of the section explaining how to enable OpenVR support.
- Add new sections for "Hololens 2" and "Meta Quest" headsets
- Add entries for "Supported headsets" and "Supported XR modality" to each headset section
- Add "How to use hand interaction" section
- Update the Contributors section to acknowledge @LucasGandel and @sankhesh.

In the DeveloperGuide:
- Remove obsolete build instructions.
- Update Python snippet.
- Add references to the documentation of associated VTK modules.
- Add the "Mapping of Controller Action to VTK event" section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document OpenXR capabilities Doc Request: Add FAQ and/or Roadmap

1 participant