From 2d0304f4ccdd008c85d160b5e06d0df98d172508 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 12 Nov 2015 11:56:35 -0500 Subject: Move README to README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..77809d8 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +PUGL +==== + +Pugl is a minimal portable API for GUIs which supports embedding and is +suitable for use in plugins. It works on X11, Mac OS X, and Windows. GUIs can +be drawn with OpenGL or Cairo. + +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.3