Removed glibmm dependency.

[lsystem3d.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d04dab162a514bded5562a3c60469e242b85fe27 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,58 @@
+DESCRIPTION
+-----------
+
+LSystem3d is a experimental Lindenmayer System generator with 3d capabilities,
+whose main goal is to generate all kinds of plants or whatever fractal
+L-system structures the user desires. For now, LSystem3D is highly under
+development and is considered alpha, that is, lots of things are missing and
+it will probably not work 100% accurate.
+
+
+
+REQUIREMENTS
+------------
+
+Currently tested in Debian GNU/Linux (Sid) only, but should compile fine on
+other platforms without bigger modification.
+
+A fast computer with HW accelerated 3D would be nice.
+
+Dependencies;
+
+OpenGL
+FOX toolkit
+libxml++
+glibmm
+
+
+
+USAGE
+-----
+
+Mouse keys:
+
+Left       move model in z-plane
+Middle     zoom in and out
+Right      rotate around the y-axis
+
+
+Rules:
+
+=     name/rule separator
+F     walk forward, leave a trace
+A-Z   rewrite operator
++     turn left
+-     turn right
+&     pitch down
+^     pitch up
+\     roll left
+/     roll right
+|     turn around 180 degrees
+[     save state to stack
+]     restore state from stack
+{     first vertex of a filled polygon
+}     last vertex of a filled polygon
+f     one vertex of a filled polygon
+!     decrease diameter of segment
+'     increase color index
+,     decrease color index