initial commit

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8315412
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+= wglarb – a small helper library for making creating OpenGL contexts with extended attributes easy
+
+wglarb is a helper library for Windows OpenGL application development. The way
+OpenGL and WGL extensions are implemented in Windows require the creation of
+an intermediary OpenGL context (and usually also intermediary window) to obtain
+access to the extension functions.
+
+wglarb hides the nasty details behind a initialization-less API. Just call
+`wglext_ChoosePixelFormatARB` and `wglext_CreateContextAttribsARB`. Initialization
+of the intermediary window and OpenGL context happen on demand as needed.
+
+**Important Notice:** 
+*At the moment only ChoosePixelFormatARB and CreateContextAttribsARB are covered.*
+Further wgl…ARB functions are yet subject for inclusion.