README
branchpyrit
changeset 44 3763b26244f0
parent 14 fc18ac4833f2
child 66 c5b89d16497a
--- a/README	Sun Dec 30 00:11:47 2007 +0100
+++ b/README	Thu Jan 03 18:06:34 2008 +0100
@@ -2,10 +2,33 @@
  Pyrit Ray Tracer
 ==================
 
-License
--------
-Currently unlicensed, you may not redistribute or use this work for any purposes.
-Will be MIT licensed when ready.
+
+File Organization
+-----------------
+/bin      -- output directory for binary objects
+/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
+
+Classes organization throughout header files is explained in DEVNOTES.
+
+
+Building
+--------
+Type 'make all' to build everything and 'make help' for list of targets.
+
+Requirements:
+    pthreads (see bellow)
+    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
+
+Flags can be adjusted in config.mk.
+
 
 Pthreads
 --------
@@ -17,3 +40,14 @@
 
 For Windows + Mingw32, 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