From 07a52129a570352b32f25e51cb8db7de8232c51f Mon Sep 17 00:00:00 2001
From: Syoyo Fujita <syoyo@lighttransport.com>
Date: Thu, 21 Feb 2013 01:08:58 +0900
Subject: [PATCH] Update README. Add usage example.

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 431527c..e469e29 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,69 @@
 tinyobjloader
 =============
 
-Tiny but poweful single file wavefront obj loader written in C++. no dependency except for C++ STL.
+Tiny but poweful single file wavefront obj loader written in C++. no dependency except for C++ STL. Good for embedding .obj loader to your renderer ;-)
+
+Features
+--------
+
+* Vertex
+* Texcoord
+* Normal
+* Material
+  * Unknown material attributes are treated as key-value.
+
+Notes
+-----
+
+Polygon is converted into triangle.
+
+
+Usage
+-----
+
+    std::string inputfile = "cornell_box.obj";
+    std::vector<tinyobj::shape_t> shapes;
+  
+    std::string err = tinyobj::LoadObj(shapes, inputfile.c_str());
+  
+    if (!err.empty()) {
+      std::cerr << err << std::endl;
+    }
+  
+    std::cout << "# of shapes : " << shapes.size() << std::endl;
+  
+    for (size_t i = 0; i < shapes.size(); i++) {
+      printf("shape[%ld].name = %s\n", i, shapes[i].name.c_str());
+      printf("shape[%ld].indices: %ld\n", i, shapes[i].mesh.indices.size());
+      assert((shapes[i].mesh.indices.size() % 3) == 0);
+      for (size_t f = 0; f < shapes[i].mesh.indices.size(); f++) {
+        printf("  idx[%ld] = %d\n", f, shapes[i].mesh.indices[f]);
+      }
+  
+      printf("shape[%ld].vertices: %ld\n", i, shapes[i].mesh.positions.size());
+      assert((shapes[i].mesh.positions.size() % 3) == 0);
+      for (size_t v = 0; v < shapes[i].mesh.positions.size() / 3; v++) {
+        printf("  v[%ld] = (%f, %f, %f)\n", v,
+          shapes[i].mesh.positions[3*v+0],
+          shapes[i].mesh.positions[3*v+1],
+          shapes[i].mesh.positions[3*v+2]);
+      }
+    
+      printf("shape[%ld].material.name = %s\n", i, shapes[i].material.name.c_str());
+      printf("  material.Ka = (%f, %f ,%f)\n", shapes[i].material.ambient[0], shapes[i].material.ambient[1], shapes[i].material.ambient[2]);
+      printf("  material.Kd = (%f, %f ,%f)\n", shapes[i].material.diffuse[0], shapes[i].material.diffuse[1], shapes[i].material.diffuse[2]);
+      printf("  material.Ks = (%f, %f ,%f)\n", shapes[i].material.specular[0], shapes[i].material.specular[1], shapes[i].material.specular[2]);
+      printf("  material.Tr = (%f, %f ,%f)\n", shapes[i].material.transmittance[0], shapes[i].material.transmittance[1], shapes[i].material.transmittance[2]);
+      printf("  material.Ke = (%f, %f ,%f)\n", shapes[i].material.emission[0], shapes[i].material.emission[1], shapes[i].material.emission[2]);
+      printf("  material.Ns = %f\n", shapes[i].material.shininess);
+      printf("  material.map_Ka = %s\n", shapes[i].material.ambient_texname.c_str());
+      printf("  material.map_Kd = %s\n", shapes[i].material.diffuse_texname.c_str());
+      printf("  material.map_Ks = %s\n", shapes[i].material.specular_texname.c_str());
+      printf("  material.map_Ns = %s\n", shapes[i].material.normal_texname.c_str());
+      std::map<std::string, std::string>::iterator it(shapes[i].material.unknown_parameter.begin());
+      std::map<std::string, std::string>::iterator itEnd(shapes[i].material.unknown_parameter.end());
+      for (; it != itEnd; it++) {
+        printf("  material.%s = %s\n", it->first.c_str(), it->second.c_str());
+      }
+      printf("\n");
+    }