https://github.com/khronosgroup/openxr-docs
OpenXR Specification sources and related material
https://github.com/khronosgroup/openxr-docs
Last synced: about 1 year ago
JSON representation
OpenXR Specification sources and related material
- Host: GitHub
- URL: https://github.com/khronosgroup/openxr-docs
- Owner: KhronosGroup
- License: other
- Created: 2019-01-31T01:20:46.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T19:59:19.000Z (about 1 year ago)
- Last Synced: 2025-05-07T10:18:30.352Z (about 1 year ago)
- Language: Python
- Size: 31.1 MB
- Stars: 154
- Watchers: 27
- Forks: 65
- Open Issues: 52
-
Metadata Files:
- Readme: README.adoc
- Changelog: CHANGELOG.Docs.md
- License: COPYING.adoc
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
ifdef::env-github[]
:note-caption: :information_source:
endif::[]
// Copyright (c) 2017-2025 The Khronos Group Inc.
//
// SPDX-License-Identifier: CC-BY-4.0
= OpenXR™ API Documentation Project
This repository contains sources for the formal documentation of the OpenXR
API. This includes:
[options="compact"]
* the OpenXR API Specification
* OpenXR header files (generated from the specification)
* related tools and scripts.
The authoritative public repository is located at
https://github.com/KhronosGroup/OpenXR-Docs/.
It hosts public Issue tracker, and accepts patches (Pull Requests) from the
general public.
== Directory Structure
The directory structure is as follows:
// REUSE-IgnoreStart
```
README.adoc This file
COPYING.md Copyright and licensing information
CODE_OF_CONDUCT.md Code of Conduct
specification/ Specification - files to generate the spec
include/openxr/ Static OpenXR header (not generated from the Registry)
```
// REUSE-IgnoreEnd
== Building the Specification and Reference Pages, and Regenerating Headers
The document sources are marked up in Asciidoctor format, and we use
`asciidoctor` and related toolchain components to generate output documents.
See link:specification/README.md[specification/README.md]
for more information on installing the toolchain and building the
Specification.
== Note about `git blame`
We are tracking "bulk commits" in the `.git-blame-ignore-revs` file, for better
git blame output. Sadly it appears that web interfaces do not yet handle this
file, but you can if using the command line. See
link:https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt[--ignore-revs-file docs]
for details, and
link:https://www.moxio.com/blog/43/ignoring-bulk-change-commits-with-git-blame[this blog post about ignore-revs]
for some useful usage details.