Skip to content

DOC: Update README and DeveloperGuide to document OpenXR backend support | ⚠️ Last commit removed from master#169

Merged
jcfr merged 3 commits intoKitwareMedical:masterfrom
jcfr:update-readme
Mar 2, 2024
Merged

DOC: Update README and DeveloperGuide to document OpenXR backend support | ⚠️ Last commit removed from master#169
jcfr merged 3 commits intoKitwareMedical:masterfrom
jcfr:update-readme

Conversation

@jcfr
Copy link
Contributor

@jcfr jcfr commented Feb 29, 2024

⚠️ Changes originally introduced in commit e5d60db via this pull request have been removed from the master branch using force push. ⚠️

➡️ These changes have been replaced by #172

Rationale:

After performing the Rebase & Merge, we realized the last commit was integrated with an incorrect title.


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.

@jcfr jcfr marked this pull request as draft February 29, 2024 23:32
@jcfr jcfr linked an issue Feb 29, 2024 that may be closed by this pull request
@jcfr jcfr force-pushed the update-readme branch 16 times, most recently from 76d4abb to f8ad267 Compare March 1, 2024 20:05
jcfr added 2 commits March 1, 2024 15:11
* Use "atx" style of section headers
* Remove empty "Usage" section
* Use "wrench" emoji when referencing the corresponding icon in the Slicer toolbar
@jcfr jcfr force-pushed the update-readme branch 10 times, most recently from 14f8323 to 318cdfb Compare March 2, 2024 02:10
@jcfr jcfr linked an issue Mar 2, 2024 that may be closed by this pull request
4 tasks
@jcfr jcfr changed the title DOC: Update README to document OpenXR backend support DOC: Update README and DeveloperGuide to document OpenXR backend support Mar 2, 2024
@jcfr jcfr marked this pull request as ready for review March 2, 2024 03:17
@jcfr jcfr force-pushed the update-readme branch 2 times, most recently from b9a3ae5 to dbfcae3 Compare March 2, 2024 03:46
- 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.
@jcfr jcfr merged commit e5d60db into KitwareMedical:master Mar 2, 2024
@jcfr jcfr deleted the update-readme branch March 2, 2024 04:41
@jcfr jcfr mentioned this pull request Mar 2, 2024
3 tasks
@jcfr jcfr changed the title DOC: Update README and DeveloperGuide to document OpenXR backend support DOC: Update README and DeveloperGuide to document OpenXR backend support | ⚠️ Last commit removed from master Mar 4, 2024
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