Commit before breaking everything

[matches/honours.git] / research / transmission_spectroscopy / simulator / pgu-0.18 / README.txt

diff --git a/research/transmission_spectroscopy/simulator/pgu-0.18/README.txt b/research/transmission_spectroscopy/simulator/pgu-0.18/README.txt
new file mode 100644 (file)
index 0000000..4148225
--- /dev/null
+++ b/research/transmission_spectroscopy/simulator/pgu-0.18/README.txt
@@ -0,0 +1,80 @@
+PGU - PyGame Utilities
+======================
+
+A collection of handy utilities and libraries created by Phil Hassey, released
+under the LGPL v2.1 (see LICENSE.txt for more details). PGU is currently 
+maintained by Peter Rogers.
+
+The new PGU website:
+
+    http://code.google.com/p/pgu/
+    [email protected]
+
+Old website location:
+
+    http://www.imitationpickles.org/pgu/
+    [email protected]
+
+Modules:
+
+    tileedit  -- edit tga based images
+    leveledit -- edit tga based levels in tile, isometric, and hexagonal formats
+    tganew    -- create tga files
+    levelfancy-- prettyify your levels
+
+    gui     -- gui with standard widget, dialogs, html, connections, and themes
+    html    -- html rendering utilities
+    layout  -- layout utilities
+    text    -- text rendering utilities
+
+    tilevid -- sprite and tile engine
+    isovid  -- isometric sprite and tile engine
+    hexvid  -- hexagonal sprite and tile engine (alpha)
+    engine  -- state engine
+    timer   -- a timer for games with set-rate FPS
+    high    -- high score tracking
+    ani     -- animation helpers
+    algo    -- helpful pathfinding algoritms
+    fonts   -- font wrappers, bitmapped fonts
+
+Vera.ttf is from:
+
+    http://ftp.gnome.org/pub/GNOME/sources/ttf-bitstream-vera/1.10/
+    see that site for more information about the font.
+
+Documentation
+=============
+
+To build the PGU documentation, run the build.py script found under docs:
+
+    $ cd docs
+    $ python build.py
+    $ your-favorite-browser index.html
+
+To understand pgu.gui -- read:
+    http://www.w3.org/TR/REC-html40/
+    (pgu.gui is based heavily on my HTML background)
+
+To understand the pgu.gui default theme -- read:
+    http://www.w3.org/TR/REC-CSS2/box.html
+    (the theme uses the css 2 box model)
+
+Example scripts can be found in the examples directory.
+
+THANKS
+======
+
+* gal koren -- bugs, draft of html.HTML, suggestions, bug finding, ScrollArea widget, FileDialog, List, Console
+* fdarling -- testing, suggestions, bug fixing, code cleanup, menus & slider UI fixes, new Table class, reorganization of pgu.gui into a package
+
+richard jones -- packaging, suggestions, code cleanup
+jhofmann -- tiled preview in tileedit and PIL support
+Dr. L. Humbert -- gui.Password widget
+illume -- added auto-load features to tile & leveledit
+python -- suggestions, bug finding, bug fixing (unicode)
+Addison Hardy -- added ScrollArea to html5.py
+dang`r`us -- testing, suggestions
+piman -- testing, suggestions
+coca-cola -- testing
+tenoften -- testing
+