OpenXR Docset

Generation tools to construct an OpenXR docset for Zeal/Dash.

Dependencies

You must have the following tools installed for the build scripts to function correctly:

• SQLite3
• Crystal
• asciidoctor
• Ruby Rouge

Usage

To generate a documentation package for a specific version of OpenXR run the following command in the root directory of the repository:

./generate 1 1 41

This example will generate the documentation for version 1.1.41.

The finished documentation package can be found at feed/OpenXR.tgz. The feed/OpenXR.xml file can be used to serve the documentation from your own web server for easy installation into Zeal, just open it up and replace the URL within with the actual URL the package will be available at.

Credit & License

Developed by Amini Allight. Licensed under the Apache License 2.0 (except for the OpenXR logo found in res/icon.png, which is a trademark of the Khronos Group).

This project is not affiliated with or endorsed by the Khronos Group. The OpenXR documentation is available separately under its own license terms.