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

Add readme files and screenshots to sample projects #191

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

devloglogan
Copy link
Collaborator

@devloglogan devloglogan commented Jul 17, 2024

Per Bastiaan's suggestion, adds readme files with screenshots to the sample projects. Since there will be doc pages for all these features, I don't go into any detail in the readmes and just link to the relevant docs (with the exception of the body tracking sample, which doesn't have relevant docs written yet).

Making this a draft for the time being because some of the doc links won't work until the corresponding doc PR is merged.

Closes #179

@devloglogan devloglogan added the documentation Improvements or additions to documentation label Jul 17, 2024
@devloglogan devloglogan added this to the 3.0.0 milestone Jul 17, 2024
> Note: this project requires Godot 4.3 or later

This is a sample project demonstrating tracking features on Meta headsets. This includes body / hand tracking, which is supported on Quest 2, Quest 3, and Quest Pro;
as well as face tracking, which is only supported on Quest Pro. For more Meta-specific hand tracking features, check out the [Meta Hand Tracking Sample](https://github.com/devloglogan/godot_openxr_vendors/tree/sample-readme-files/samples/meta-hand-tracking-sample).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to the meta hand tracking sample is pointing to your branch instead of the documentation page.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, fixed the link to point to the hand tracking sample project on upstream master.

@devloglogan devloglogan marked this pull request as ready for review July 18, 2024 13:40
@devloglogan
Copy link
Collaborator Author

All the doc PRs are merged now, so opening this PR. :)

@devloglogan devloglogan changed the title [DRAFT] Add readme files and screenshots to sample projects Add readme files and screenshots to sample projects Jul 18, 2024
@m4gr3d m4gr3d merged commit da4dc4e into GodotVR:master Jul 18, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommendation: Add README.MD file in each sample
2 participants