Add the autogen.sh script to the source tree.

[lsystem3d.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..9343d71ed76fe5ab401e263432eddbb748e8de89 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,77 @@
+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 on Debian GNU/Linux (Sid) only, but should compile fine on
+other platforms without bigger modifications.
+
+A fast computer with HW accelerated 3D would be nice.
+
+
+Dependencies:
+
+OpenGL
+FOX toolkit
+libxml++
+
+
+
+USAGE
+-----
+
+Rendering window:
+
+Left mouse button:   Move model in z-plane
+Middle mouse button: Zoom in/out
+Right mouse button:  Rotate around y-axis
+
+
+Controller window:
+
+Axiom:    Initial rule
+Rules:    The L-system rules
+Angle:    Turn/pitch/roll angle
+Depth:    Depth of recursion
+Diameter: Initial diameter of segment
+Factor:   For each recursion level, multiply segment diameter with this value
+Generate: Generate the L-system
+
+
+Rules:
+
+F       Walk forward, creating a segment
+A-Z     Replacement rule
+A(0.33) Probability factor 0.33 for rule A
+=       Rule assignment
++       Turn left
+-       Turn right
+&       Pitch down
+^       Pitch up
+\       Roll left
+/       Roll right
+|       Turn around 180 degrees
+[       Save state to stack
+]       Load state from stack
+{       Create a planar surface
+}       Close a planar surface
+f       One vertex in a planar surface, specified CCW
+!       Decrement segment diameter
+'       Increment current index to color table
+,       Decrement current index to color table
+
+Example:
+
+F(0.33)=[+FL]F/[-FL]F!
+F(0.33)=F[&FL]F!
+F(0.34)=F/[-FL]&F!
+L={,-f++f-|-f++f-'}