summaryrefslogtreecommitdiffstats
path: root/python/planes/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/planes/README')
-rw-r--r--python/planes/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/python/planes/README b/python/planes/README
new file mode 100644
index 0000000000..1cef88d882
--- /dev/null
+++ b/python/planes/README
@@ -0,0 +1,9 @@
+planes is a hierarchical surface framework for PyGame by Florian Berger.
+
+The planes module introduces the "Plane" class which extends PyGame's
+"Surface" functionality, offering a hierarchy of mouse-sensitive, draggable
+Surfaces that can be used as sprites, windows, icons or other interactive
+elements.
+
+In addition, the planes.gui module uses planes to provide basic GUI
+elements like container, label, text box, option list and button.