From 8cbedf0261ec0e1cfe51da2a7ccb7358918d967b Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 1 May 2012 01:15:58 +0000 Subject: Add AUTHORS and README file. Add doc comments for each file. --- README | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..87742f4 --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +PUGL +==== + +Pugl is a minimal portable API for OpenGL GUIs which supports embedding and is +suitable for use in plugins. It works on X11, Mac OS X, and Windows. + +Pugl is vaguely similar to GLUT, but with some significant distinctions: + + * Minimal in scope, providing only what is necessary to draw and receive + keyboard and mouse input. + + * No reliance on static data whatsoever, so the API can be used in plugins or + multiple independent parts of a program. + + * Single implementation, which is small, liberally licensed Free / Open Source + Software, and suitable for direct inclusion in programs if avoiding a + library dependency is desired. + + * Support for embedding in other windows, so Pugl code can draw to a widget + inside a larger GUI. + + * More complete support for keyboard input, including additional "special" + keys, modifiers, and support for detecting individual modifier key presses. + +For more information, see . + + -- David Robillard -- cgit v1.2.1