aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-05-01 01:15:58 +0000
committerDavid Robillard <d@drobilla.net>2012-05-01 01:15:58 +0000
commit8cbedf0261ec0e1cfe51da2a7ccb7358918d967b (patch)
tree1cc50f43041ccd072b67c993a990cc0dd2050bec /README
parent0f2556e3c1cef484ebda4e2f0f2be507b2c0a482 (diff)
Add AUTHORS and README file.
Add doc comments for each file.
Diffstat (limited to 'README')
-rw-r--r--README27
1 files changed, 27 insertions, 0 deletions
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 <http://drobilla.net/software/pugl>.
+
+ -- David Robillard <d@drobilla.net>