From 3ca66b6d92b6664f6afabf9a93d9ad06756cc312 Mon Sep 17 00:00:00 2001 From: HampusM Date: Sun, 5 Mar 2023 21:46:08 +0100 Subject: docs: add readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a370f9 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +## OpenGL-Registry +[![Latest Version](https://img.shields.io/crates/v/opengl-registry)](https://crates.io/crates/opengl-registry) +[![Documentation](https://img.shields.io/docsrs/opengl-registry)](https://docs.rs/opengl-registry) + +Rust API for the OpenGL API and Extension Registry. + +## Features +- `include-xml`: Include the registry XML file as a `&'static str` (Enabled by default) + +## Example usage +```rust +use opengl_registry::Registry; + +let registry = Registry::retrieve().unwrap(); + +for command in registry.commands() { + println!("Command {}", command.prototype().name()); + println!(" Return type: {}", command.prototype().return_type()); + println!(" Parameters:"); + + for param in command.parameters() { + println!(" {} {}", param.get_type(), param.name()); + } +} +``` + -- cgit v1.2.3-18-g5258