diff -r 96d65f841791 -r 4c8abb8977dc README --- a/README Tue May 06 09:39:58 2008 +0200 +++ b/README Thu May 08 09:21:25 2008 +0200 @@ -5,39 +5,52 @@ File Organization ----------------- -/bin -- output directory for binary objects +/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 all' to build everything and 'scons -h' for list of targets. +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 - PIL (Python Imaging Library) for Python demos SDL for interactive C++ demos - libpng and zlib for rendering to PNG file from 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 rows of picture paralelly. Arbitrary number -of threads can be used, even numbers like 17 are acceptable. +Threads can be used to render rays paralelly. Arbitrary number +of threads can be used. -To completely disable this feature just remove "-DPTHREADS -pthreads" -from flags in makefile. - -For Windows + Mingw32, get pthreads library here: +For Windows, get pthreads library here: http://sources.redhat.com/pthreads-win32/