Documentation updates. Version 1.

[python-bulletml.git] / README.txt

diff --git a/README.txt b/README.txt
index cd2a6d4..c7a1633 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -5,7 +5,15 @@ BulletML is the Bullet Markup Language. BulletML can describe the
 barrage of bullets in shooting games. (For example Progear, Psyvariar,
 Gigawing2, G DARIUS, XEVIOUS, ...) This module parses and executes
 BulletML scripts in Python. All data structures in it are
-renderer-agnostic. A sample renderer for Pygame is included.
+renderer-agnostic.
+
+In addition to the standard BulletML XML format, this module supports
+an equivalent YAML format. See bulletml.bulletyaml for more details.
+
+Finally, two simple collision routines are provided, bulletml.overlaps
+for stationary circles and bulletml.collides for moving circles.
+
+A sample renderer for Pygame is included.
 
 More information is available at the BulletML homepage,
 http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html, or the
@@ -19,6 +27,9 @@ respawn the bullet pattern, and Enter to restart it.
 
 Installing
 ----------
+BulletML requires Python 2.6 or later. It should work on Python 3. It
+has no dependencies outside the CPython standard library.
+
 $ ./setup.py build
 $ sudo ./setup.py install