Skip to content

Commit

Permalink
Markdown lint violation fixing
Browse files Browse the repository at this point in the history
  • Loading branch information
rpavlik committed Oct 1, 2024
1 parent 9714d13 commit 6d36648
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# OpenXR-Tutorial

This OpenXR-Tutorial repository contains both the text and code samples for the OpenXR-Tutorial website (https://openxr-tutorial.com/).
This OpenXR-Tutorial repository contains both the text and code samples for the OpenXR-Tutorial website <https://openxr-tutorial.com/>.

![image](tutorial/images/OpenXR_500px_Feb17_White.png#gh-dark-mode-only)
![image](tutorial/images/OpenXR_500px_Feb17_RGB.png#gh-light-mode-only)

## Table of Contents

- [OpenXR-Tutorial](#openxr-tutorial)
- [Table of Contents](#table-of-contents)
- [Chapters](#chapters)
Expand All @@ -14,7 +15,7 @@ This OpenXR-Tutorial repository contains both the text and code samples for the
- [3. Graphics](#3-graphics)
- [4. Interactions](#4-interactions)
- [5. Extensions](#5-extensions)
- [6. Next Setup](#6-next-setup)
- [6. Next Setup](#6-next-steps)
- [Website](#website)
- [Setup](#setup)
- [Build](#build)
Expand All @@ -26,31 +27,35 @@ This OpenXR-Tutorial repository contains both the text and code samples for the
- [Repository](#repository)
- [Related resources](#related-resources)


## Chapters

### 1. Introduction

This chapter describes the goals of OpenXR and gives an overview of the core concepts used in the API. It describes how to set up your project as well.

### 2. OpenXR Setup

This chapter explains how to set up an [`XrInstance`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XrInstance.html) and [`XrSession`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XrSession.html). It also discusses how to poll events in OpenXR.

### 3. Graphics

[`XrSwapchain`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XrSwapchain.html) construction is explained in this chapter along with the [`XrEnvironmentBlendMode`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XrEnvironmentBlendMode.html) and the [`XrReferenceSpaceType`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XrReferenceSpaceType.html). Finally, it explains how to set up a render loop and draw some simple geometry.

### 4. Interactions

This chapter focuses solely on explaining and demonstrating both the interaction profile and action systems that OpenXR uses. These systems provide a way for developers and users to bind inputs to actions allowing greater cross-vendor compatibility of an application.

### 5. Extensions

This chapter discusses a few extensions for Hand tracking and Composition Layer Depth. Extensions allow greater functionality to be added to an application provided that the hardware and runtime support them.

### 6. Next Steps
This chapter contains a collection of topics to act as a jumping-off point to explore further the diverse and ever-growing world of XR development. Of note are the sections on Multiview rendering, OpenXR API Layers and Multithreaded rendering.

This chapter contains a collection of topics to act as a jumping-off point to explore further the diverse and ever-growing world of XR development. Of note are the sections on Multiview rendering, OpenXR API Layers and Multithreaded rendering.

## Website

https://openxr-tutorial.com/
<https://openxr-tutorial.com/>

![image](tutorial/screencapture-openxr-tutorial-index.png)

Expand All @@ -59,26 +64,29 @@ https://openxr-tutorial.com/
Prerequisites: [git](https://git-scm.com/downloads)

Clone the repo with submodules using the following command:
```

```sh
git clone https://github.com/KhronosGroup/OpenXR-Tutorials.git
cd OpenXR-Tutorials
```

Follow build instructions for your platform below.

## Build

### Supported Platforms
* Windows - [Build Guide](BUILD.md#windows)

* Linux - [Build Guide](BUILD.md#linux)
- Windows - [Build Guide](BUILD.md#windows)

- Linux - [Build Guide](BUILD.md#linux)

* Android - [Build Guide](BUILD.md#android)
- Android - [Build Guide](BUILD.md#android)

### Building the Tutorial Website

The tutorial website is built with [Sphinx](https://www.sphinx-doc.org), a Python-based documentation build tool. To build the website, set the CMake variable `XR_TUTORIAL_BUILD_DOCUMENTATION` to `TRUE`. Set the CMake variable `BUILD_ALL_EXTENSIONS` to `FALSE` if you only intend to build the documentation and might be missing requirements for graphics APIs. Install the following Python modules:

```
```sh
pip install sphinx==6.1.3
pip install breathe
pip install myst-parser
Expand Down

0 comments on commit 6d36648

Please sign in to comment.