aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 21 insertions, 17 deletions
diff --git a/README.md b/README.md
index c5361b9..77809d8 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,28 @@
-Autowaf
-=======
+PUGL
+====
-This is autowaf, a bundle of waf and a few extensions intended to be easy to
-use directly as source code in a project. Using this as a submodule or subtree
-named `waflib` in a project allows waf to be used without including binary
-encoded data in the waf script. This gets along with revision control and
-distributions better, among other advantages, without losing
-self-containedness.
+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.
-To use this in a project, add this repository as a directory named `waflib` in
-the top level of the project, and link or copy `waf` to the top level.
+Pugl is vaguely similar to GLUT, but with some significant distinctions:
-Two waf extras are also included: `autowaf.py` and `lv2.py`.
+ * Minimal in scope, providing only what is necessary to draw and receive
+ keyboard and mouse input.
-The `autowaf.py` module is a kitchen sink of Python utilities for building
-consistent packages, and can be imported in a wcript as
-`waflib.extras.autowaf`.
+ * No reliance on static data whatsoever, so the API can be used in plugins or
+ multiple independent parts of a program.
-The `lv2.py` extra defines options for LV2 plugin installation paths. It can
-be used by calling `opt.load('lv2')` and `conf.load('lv2')` in the appropriate
-locations in a wscript.
+ * 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>