[rename] example 10; [add] example readme

3 files changed, 79 insertions, 1 deletions

diff --git a/examples/10-canvas.lisp b/examples/10-canvas-sneks.lisp
index 453ef0e..453ef0e 100644
--- a/examples/10-canvas.lisp
+++ b/examples/10-canvas-sneks.lisp
diff --git a/examples/README.txt b/examples/README.txt
new file mode 100644
index 0000000..c4100eb
--- /dev/null
+++ b/examples/README.txt
@@ -0,0 +1,78 @@
+EXAMPLES
+
++----------------------------------
+| 01-bitmap-display.lisp
+
+This is the "sanity check" example. It ensures that basic things can
+happen like "loading textures from disk" and "displaying textures".
+
+
++----------------------------------
+| 02-moving-bitmp.lisp
++----------------------------------
+
+This is a grab bag of various features. You should just look at the
+source. Try clicking on different objects, pressing arrow keys,
+rolling the mouse etc.
+
++----------------------------------
+| 03-font-render.lisp
++----------------------------------
+
+An example of some text being rendered to a clickable unit.
+
++----------------------------------
+| 04-a-button.lisp
++----------------------------------
+
+A button class I made for no good reason. Just click on the two images.
+
++----------------------------------
+| 05-frameset-animation.lisp
++----------------------------------
+
+A frameset is just a collection of images to display, one after the
+other, at a particular rate. You can do normal affine things to a
+frameset.
+
++----------------------------------
+| 06-sprite.lisp
++----------------------------------
+
+A sprite is a collection of named framesets. Each name represents a
+"view" of the sprite. For example: one view might have a character
+looking forward, the ohter looking to the left.
+
+You can move a little character around on the screen.
+
+
++----------------------------------
+| 07-renderarea.lisp
++----------------------------------
+
+An example of containing the dispaly of an object within a particular screen region.
+
++----------------------------------
+| 08-pong.lisp
++----------------------------------
+
+Pong for one.
+
++----------------------------------
+| 09-ghoulspree.lisp
++----------------------------------
+
+An example where loads of sprites are rendered an animted to the screen.
+You can switch gravity on and off.
+You can switch collissions on and off.
+You can click to add more sprites.
+
++----------------------------------
+| 10-canvas-sneks.lisp
++----------------------------------
+
+A demo that shows how you can draw pixels to a canvas object, updating
+that canvas each frame.
+
+Though canvas objects are not meant for per-frame animations, you can do
+simple things like this without much trouble.
diff --git a/wheelwork-examples.asd b/wheelwork-examples.asd
index 80fd4a6..862358c 100644
--- a/wheelwork-examples.asd
+++ b/wheelwork-examples.asd
@@ -15,4 +15,4 @@
                (:file "07-renderarea")
                (:file "08-pong")
                (:file "09-ghoulspree")
-               (:file "10-canvas")))
+               (:file "10-canvas-sneks")))