*** empty log message ***

[lsystem3d.git] / README

diff --git a/README b/README
index 2130ff7461b256b73e2d44a1ffbb373192bf7ffe..d04dab162a514bded5562a3c60469e242b85fe27 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ 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
+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.
 
@@ -15,12 +15,12 @@ REQUIREMENTS
 Currently tested in Debian GNU/Linux (Sid) only, but should compile fine on
 other platforms without bigger modification.
 
-Necessary libs:
+A fast computer with HW accelerated 3D would be nice.
+
+Dependencies;
 
 OpenGL
-GLU
-GLUI User Interface Library
-GLUT (freeglut)
+FOX toolkit
 libxml++
 glibmm
 
@@ -29,24 +29,18 @@ glibmm
 USAGE
 -----
 
-Keys:
+Mouse keys:
 
-Esc        quit
-+          zoom in
--          zoom out
-y          rotate around the y-axis
-Up         move camera up
-Down       move camera down
-Left       move camera left
-Right      move camera right
-PageUp     move camera forth
-PageDown   move camera back
+Left       move model in z-plane
+Middle     zoom in and out
+Right      rotate around the y-axis
 
 
 Rules:
 
 =     name/rule separator
-A-Z   rewrite operator, step forward
+F     walk forward, leave a trace
+A-Z   rewrite operator
 +     turn left
 -     turn right
 &     pitch down
@@ -56,30 +50,9 @@ A-Z   rewrite operator, step forward
 |     turn around 180 degrees
 [     save state to stack
 ]     restore state from stack
-{     first vertex of a filled surface
-}     last vertex of a filled surface
-f     one vertex of a filled surface
-!     decrement diameter of segment
-
-
-Example:
-
-The GUI input
-
-Axiom:       A
-Rule #1:     A=A/[!+A&A]/A
-Angle:       30.0
-Iterations:  4
-
-will render a simple l-system and create the xml-structure
-
-<?xml version="1.0"?>
-<lsystem>
-  <axiom>A</axiom>
-  <rule name="A">A/[!+A&amp;A]/A</rule>
-  <angle>30.0</angle>
-  <iterations>4</iterations>
-</lsystem>
-
-and save it to the file named "lsystem.xml" when quitting. The same file will
-be initially loaded every time LSystem3d is started.
+{     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