Merge pull request #3 from vcaputo/docs

text: update README and TODO

1 files changed, 8 insertions, 9 deletions

diff --git a/README b/README
index e05473e..4f9dbb6 100644
--- a/README
+++ b/README
@@ -1,3 +1,10 @@
+rototiller is, rendered entirely in software:
+	roto: a simple fixed-point tiled texture rotation
+	ray: a multi-threaded ray tracer
+	sparkler: a fireworks-like particle system with spatial interactions
+
+---
+
 This is a quick little graphics hack I put together to experiment with libdrm
 and this "dumb buffer" thingy David Airlie added to the kernel back in 2011.
 
@@ -18,14 +25,6 @@ resolutions and abundant memory for 32bpp with page flipping.
 
 In my testing so far, this seems to work without even requiring root.
 
-The test machine is a 1.6Ghz Core2 duo w/i915 and 1400x1050 (x61s w/SXGA+), and
-rototiller64 only uses 30-40% of one core, rendering a flawless 50HZ.
-
-As for the files, they're identical, except rototiller64 writes 64-bit words at
-a time to the graphics buffer, rototiller32 writes 32-bit words at a time.  On
-the test machine 64-bit is good for a few % CPU savings.  I included the 32-bit
-version since it's simpler to read and maybe you have a 32-bit box.
-
 Before you try to run these things, realize this is direct libdrm graphics,
 it's going to compete with your X/wayland server.  Switch to a plain virtual
 console to run the program.  You don't need to quit X, just switch away from the
@@ -33,7 +32,7 @@ X vt so it's not visible.
 
 To quit it's as simple as Ctrl-C, rototiller will otherwise run forever.
 
-Do not try switching back to X while rototiller is running, Ctrl-C it first, or
+Do not try switching back to X while rototiller is drawing, Ctrl-C it first, or
 X will get angry and exit when it tries to do drm things and can't.
 
 Your display may be left in an inconsistent state after exiting rototiller.