Opale.Soya   * README *

 * INDEX *
./opale/soya/README                 Read !
./opale/soya/compile.sh             Script to compile Opale.Soya
./opale/soya/makejavadoc.sh         Script to compile javadocs
./opale/soya/doc/                   Docs (about the 3D engine in opale.soya/ and about 3D editor in editor/)
./opale/soya/tutorial/              Tutorials. Include source code and resource files.

 * Dependancies *
To use Opale.Soya, you need :
-A java virtual machine : The sun 1.3 JVM (java.sun.com) is advised ; other may work or not, and have not been tested. The JVM must be supported by GL4Java (see next item). The SDK version is required to compile the source.
-GL4Java (www.jausoft.com/gl4java) : needed to access to OpenGL from Java.
-OpenGL Driver : Should come with your OS; newer drivers may have better performances. All OpenGL are supported, including Mesa (www.mesa.org).

 * Compilation *
Sources are totaly Java; just compile them as java code with your java compilator.
A script can be helpfull : ./opale/soya/compile.sh (Add classpath if necessary).
    cd [your Opale.Soya directory]
    ./opale/soya/compile.sh

 * Javadoc *
Sources are javadoced.
To compile javadoc, use this script : ./opale/soya/makejavadoc.sh.
    cd [your Opale.Soya directory]
    ./opale/soya/makejavadoc.sh
About those javadoc :
-Methods that override another method are not always documented; in this case please refer to the doc of the original method.
-Properties' getter (get*(), is*()) are often better documented than their setter (set*()).

 * Editor *
Opale.Soya include a 3D editor.
To run it : (Add classpath if necessary) :
    cd [your Opale.Soya directory]
    java opale.soya.editor.Editor
The directory ./opale/soya/doc/editor/ contains the editor's handbook.

 * Tutorials and other docs *
A general doc about Opale.Soya is waiting for you here : ./opale/soya/doc/opale.soya/handbook.html .
Tutorials are in ./opale/soya/tutorial/ . Lessons < 100 concern basic concepts and lessons >= 100 special effects,...

A11W (a11w@SoftHome.net)
Opale.Soya is avalaible at [web site addresse]