README
branchpyrit
changeset 44 3763b26244f0
parent 14 fc18ac4833f2
child 66 c5b89d16497a
equal deleted inserted replaced
43:0b8b968b42d1 44:3763b26244f0
     1 ==================
     1 ==================
     2  Pyrit Ray Tracer
     2  Pyrit Ray Tracer
     3 ==================
     3 ==================
     4 
     4 
     5 License
     5 
     6 -------
     6 File Organization
     7 Currently unlicensed, you may not redistribute or use this work for any purposes.
     7 -----------------
     8 Will be MIT licensed when ready.
     8 /bin      -- output directory for binary objects
       
     9 /ccdemos  -- ray tracer demos in C++
       
    10 /demos    -- ray tracer demos in Python
       
    11 /include  -- header files
       
    12 /models   -- common models for use by demos
       
    13 /src      -- ray tracing library source code
       
    14 /tests    -- test programs for classes
       
    15 
       
    16 Classes organization throughout header files is explained in DEVNOTES.
       
    17 
       
    18 
       
    19 Building
       
    20 --------
       
    21 Type 'make all' to build everything and 'make help' for list of targets.
       
    22 
       
    23 Requirements:
       
    24     pthreads (see bellow)
       
    25     Python 2.4 or newer for Python module and demos
       
    26     PIL (Python Imaging Library) for Python demos
       
    27     SDL for interactive C++ demos
       
    28     libpng and zlib for rendering to PNG file from C++ demos
       
    29 
       
    30 Flags can be adjusted in config.mk.
       
    31 
     9 
    32 
    10 Pthreads
    33 Pthreads
    11 --------
    34 --------
    12 Threads can be used to render rows of picture paralelly. Arbitrary number
    35 Threads can be used to render rows of picture paralelly. Arbitrary number
    13 of threads can be used, even numbers like 17 are acceptable.
    36 of threads can be used, even numbers like 17 are acceptable.
    15 To completely disable this feature just remove "-DPTHREADS -pthreads"
    38 To completely disable this feature just remove "-DPTHREADS -pthreads"
    16 from flags in makefile.
    39 from flags in makefile.
    17 
    40 
    18 For Windows + Mingw32, get pthreads library here:
    41 For Windows + Mingw32, get pthreads library here:
    19 http://sources.redhat.com/pthreads-win32/
    42 http://sources.redhat.com/pthreads-win32/
       
    43 
       
    44 
       
    45 License
       
    46 -------
       
    47 This software is published under terms of MIT license.
       
    48 See COPYING for full text of license.
       
    49 
       
    50 
       
    51 Website
       
    52 -------
       
    53 Latest version can be obtained at http://wiki.fiction.cz/Pyrit