aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2023-03-07 21:52:23 +0100
committerHampusM <hampus@hampusmat.com>2023-03-07 21:52:23 +0100
commit1a5cb3448c9575665729ff49ba789ca816bfe3cb (patch)
tree7f0cfaa20b5d2536a7f1f4a1c025982c1bdfcaa3
parent0484f1558669ca971f5843d7e79f5aaf22e6bcf2 (diff)
docs: add readmev0.1.0
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63eec7b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+## OpenGL-Registry-Macros
+[![Latest Version](https://img.shields.io/crates/v/opengl-registry-macros)](https://crates.io/crates/opengl-registry-macros)
+[![Documentation](https://img.shields.io/docsrs/opengl-registry-macros)](https://docs.rs/opengl-registry-macros)
+
+Rust macros utilizing the OpenGL API and Extension Registry.
+
+## Example usage
+```rust
+use opengl_registry_macros::for_each_opengl_command;
+
+for_each_opengl_command! {
+ fn #gl_command_name(#gl_command_args) -> #gl_command_ret_type
+ {
+ println!("Hello from {}", stringify!(#gl_command_name));
+
+ unimplemented!();
+ }
+}
+```
+