==================

 Pyrit Ray Tracer

==================

File Organization

-----------------

/build    -- output directory for binaries and other generated files

/ccdemos  -- ray tracer demos in C++

/demos    -- ray tracer demos in Python

/include  -- header files

/models   -- common models for use by demos

/src      -- ray tracing library source code

/tests    -- test programs for classes

/tools    -- auxiliary programs

Classes organization throughout header files is explained in DEVNOTES.

Building

--------

Type 'scons pyrit' to build and 'scons -h' for list of targets.

Requirements:

    SCons

    pthreads (see bellow)

    libpng, zlib

    Python 2.4 or newer for Python module and demos

    SDL for interactive C++ demos

It should build with these compilers: GCC, IntelC, MSVC

GCC is default in Linux, MSVC is default in Windows.

Downloading model files

-----------------------

Not all models are included in distribution. To download the large

Stanford models, type 'scons download-models', which will download

end extract the archives to appropriate location.

The download script uses 'tar' and 'wget' utilities.

For Windows, these are available here:

http://gnuwin32.sourceforge.net/packages/wget.htm

http://gnuwin32.sourceforge.net/packages/libarchive.htm

Pthreads

--------

Threads can be used to render rays paralelly. Arbitrary number

of threads can be used.

For Windows, get pthreads library here:

http://sources.redhat.com/pthreads-win32/

License

-------

This software is published under terms of MIT license.

See COPYING for full text of license.

Website

-------

Latest version can be obtained at http://wiki.fiction.cz/Pyrit