1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.rst	Mon Dec 28 10:27:23 2015 +0200
     1.3 @@ -0,0 +1,37 @@
     1.4 +Realtime GPU (OpenCL) polygon mesh raytracer
     1.5 +============================================
     1.6 +
     1.7 +About
     1.8 +-----
     1.9 +Clray is an experimental realtime GPU raytracer with OpenCL. It renders polygon
    1.10 +mesh scenes loaded from obj files (with minor extensions to the material
    1.11 +description format), using a kd-tree constructed with the surface area heuristic
    1.12 +(SAH) for ray-test acceleration.
    1.13 +
    1.14 +If you want to try clray, a few test scenes can be found at:
    1.15 +http://nuclear.mutantstargoat.com/sw/clray/clray_test_scenes.tar.gz
    1.16 +
    1.17 +License
    1.18 +-------
    1.19 +Copyright (C) John Tsiombikas <nuclear@member.fsf.org>
    1.20 +
    1.21 +Clray is free software; feel free to use, modify, and/or redistribute it, under
    1.22 +the terms of the GNU General Public License version 3, or (at your option) any
    1.23 +more recent version published by the Free Software Foundation. See COPYING for
    1.24 +details.
    1.25 +
    1.26 +Material file format extensions
    1.27 +-------------------------------
    1.28 +Clray will happily read obj/mtl files as exported by most programs. However, the
    1.29 +obj material file format does not specify a reflectivity factor. For this reason
    1.30 +I've added a custom mtl command named "Nr" to specify reflectivity. Just add it
    1.31 +manually to any material you want to make reflective, followed by a number in
    1.32 +the range ``[0, 1]``. For instance a reflective red material with white specular
    1.33 +highlights could be defined as follows::
    1.34 +
    1.35 +  newmtl mat_red_shiny
    1.36 +  Ka 1 0 0
    1.37 +  Kd 1 0 0
    1.38 +  Ks 0.8 0.8 0.8
    1.39 +  Ns 80
    1.40 +  Nr 0.75