X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README;h=2130ff7461b256b73e2d44a1ffbb373192bf7ffe;hb=9469555e9034ef089e49b090b65253e73a19f357;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=4a55b133332457134ac1f044e76454966554d7b3;p=lsystem3d.git

diff --git a/README b/README
index e69de29..2130ff7 100644
--- a/README
+++ b/README
@@ -0,0 +1,85 @@
+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.
+
+Necessary libs:
+
+OpenGL
+GLU
+GLUI User Interface Library
+GLUT (freeglut)
+libxml++
+glibmm
+
+
+
+USAGE
+-----
+
+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
+
+
+Rules:
+
+=     name/rule separator
+A-Z   rewrite operator, step forward
++     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 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.