loader_aw

commit a77166e939dee84af2565e8cfce495e1bc9d650c
parent 5bd48ae6156e9f7463b13fc77678155ffb3caf19
Author: vaplv <vaplv@free.fr>
Date:   Sun, 21 Sep 2014 15:56:57 +0200

Add a README file

Diffstat:
A
README.md
 | 
27
+++++++++++++++++++++++++++

1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# Loader of the Alias Wafefront obj and mtl file formats
+
+This C89 code base loads the Alias Wavefront
+[`obj`](http://www.martinreddy.net/gfx/3d/OBJ.spec) and
+[`mtl`](http://www.fileformat.info/format/material/) file formats. Note that
+only a subset of these formats are currently supported.
+
+For `obj` files, polygonal primitives with their per vertex position, normal
+and texture coordinates are loaded. Smooth, common and material groupings are
+also correctly handled.
+
+For `mtl` files, the ambient, diffuse, specular, glossiness and transmissive RGB
+or XYZ colors are supported. In addition, it loads the refraction index and the
+illumination model. It also handles the ambient, diffuse, specular, glossiness and
+bump textures as well as their attributes (blend< u|v \>, color correction,
+channel mapping, texcoord < offset|scale|turbulence \>, image resolution and bump
+multiplier).
+
+# How to build
+
+The library uses [CMake](http://www.cmake.org) and the RCMake package to build.
+It also depends on the RSys library. First, install the RCMake package and the
+RSys library. Then, generate the project from the cmake/CMakeLists.txt file by
+appending the RCMake lib/cmake and RSys install directories to the
+`CMAKE_PREFIX_PATH` variable. The resulting project can be edited, built,
+tested and installed as any CMake project.
+