summaryrefslogtreecommitdiffstats
path: root/third_party/rust/khronos_api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/khronos_api/README.md')
-rw-r--r--third_party/rust/khronos_api/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/third_party/rust/khronos_api/README.md b/third_party/rust/khronos_api/README.md
new file mode 100644
index 0000000000..71576fa9f5
--- /dev/null
+++ b/third_party/rust/khronos_api/README.md
@@ -0,0 +1,29 @@
+# khronos_api
+
+[![Version](https://img.shields.io/crates/v/khronos_api.svg)](https://crates.io/crates/khronos_api)
+[![License](https://img.shields.io/crates/l/khronos_api.svg)](https://github.com/brendanzab/gl-rs/blob/master/LICENSE)
+[![Downloads](https://img.shields.io/crates/d/khronos_api.svg)](https://crates.io/crates/khronos_api)
+
+The Khronos XML API Registry, exposed as byte string constants.
+
+```toml
+[build-dependencies]
+khronos_api = "1.0.0"
+```
+
+The following constants are provided:
+
+- `GL_XML`: the contents of [`gl.xml`](https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/gl.xml)
+- `EGL_XML`: the contents of [`egl.xml`](https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/egl.xml)
+- `WGL_XML`: the contents of [`wgl.xml`](https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/wgl.xml)
+- `GLX_XML`: the contents of [`glx.xml`](https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/glx.xml)
+- `WEBGL_IDL`: the contents of [`webgl.idl`](https://raw.githubusercontent.com/KhronosGroup/WebGL/master/specs/latest/1.0/webgl.idl)
+- `WEBGL2_IDL`: the contents of [`webgl2.idl`](https://raw.githubusercontent.com/KhronosGroup/WebGL/master/specs/latest/2.0/webgl2.idl)
+- `WEBGL_EXT_XML`: the contents of the WebGL extension XML files
+
+## Changelog
+
+### v1.0.0
+
+- Initial release
+- Documentation improvements