X-Git-Url: https://git.yukkurigames.com/?p=python-bulletml.git;a=blobdiff_plain;f=README.txt;h=c7a1633179c317943f35980681c298b29ddafa88;hp=cd985bebafd918384b5650854293516b8623a59e;hb=e360de79a855c7c2a1dc80ae940aad00962175ad;hpb=259cb70b213abdbcc0ae255aaf275e0bfeabbb10

diff --git a/README.txt b/README.txt
index cd985be..c7a1633 100644
--- a/README.txt
+++ b/README.txt
@@ -1,21 +1,35 @@
 python-bulletml - BulletML for Python
 -------------------------------------
 
-This module parses and runs BulletML scripts. BulletML is a markup
-language for describing complex bullet patterns in shooting games.
-More information is available at the BulletML homepage,
-http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html.
+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.
+
+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.
 
-The module code is renderer-agnostic. 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
+python-bullet homepage, http://code.google.com/p/python-bulletml/.
 
 $ ./bulletml-runner examples/*/*.xml
 
-Use Page Up and Page Down to switch between bullet definitions.
+Use Page Up and Page Down to switch between bullet definitions, S to
+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
 
@@ -23,6 +37,12 @@ $ sudo ./setup.py install
 License
 -------
 
+The BulletML specification is the work of Kenta Cho.
+
+All example BulletML files in the examples folder are released into
+the public domain. Everything else is covered by the following
+license:
+
 Copyright 2010 Joe Wreschnig
 
 Permission is hereby granted, free of charge, to any person obtaining a copy