Add readme

raywan · Aug 9, 2019 · 9a4c6d7 · 9a4c6d7
1 parent 91a2c45
commit 9a4c6d7
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 24 deletions.
diff --git a/.gitignore b/.gitignore
@@ -710,5 +710,7 @@ MigrationBackup/
 toy
 renders
 *.png
+!screenshots/*.png
 render.png
-build.ninja
+build.ninja
+TODO.txt
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# rays
+
+### Ray's Ray Tracer - A (Forever In-progress) Monte Carlo Path Tracing Renderer
+
+**2019/08/08** - Project still needs a lot of work and I haven't worked on it in a while, but I need to open-source this repo for reasons.
+
+## Features
+- **Currently:** 3.2 million rays/second
+- Multi-threaded tile-based rendering
+- Bounding Volume Hierarchy (BVH) as an acceleration structure
+- Procedural texturing
+- Wavefront OBJ file parsing and rendering 
+- Lambertian BRDF
+- Stratified sampling
+- Math (vectors, matrices), high-resolution timing, memory arena allocator and more via [raywan/rw](https://github.com/raywan/rw)
+
+## Screenshot
+
+- Suzanne and 3 Spheres (2048spp, max depth of 3)
+
+  ![3 depth, 2048spp](screenshots/render_3d2048spp.png)
+
+## Building
+
+This project supports Windows, Mac and Linux and uses [Ninja](https://ninja-build.org) for building. There's also a `build.bat` file for Windows.
+
+```
+python configure.py
+ninja
+```
+
+## Dependencies
+
+- [raywan/rw](https://github.com/raywan/rw) - everything
+- [nothings/stb](https://github.com/nothings/stb) - stb_image_writer.h
+
+## Resources
+
+- [PBRT](http://www.pbr-book.org/)
diff --git a/TODO.txt b/TODO.txt
diff --git a/screenshots/render_3d2048spp.png b/screenshots/render_3d2048spp.png
diff --git a/src/world.cpp b/src/world.cpp
@@ -117,12 +117,12 @@ void create_world(World *world) {
     100.0f, // intensity
   });
 
-  // world->lights.push_back({
-  //   LT_SPHERE,
-  //   rwm_v3_init(-2.0, 2.0, -3.0), // position
-  //   rwm_v3_init(0.0f, 0.0f, 1.0f), // color
-  //   600.0f, // intensity
-  // });
+  world->lights.push_back({
+    LT_SPHERE,
+    rwm_v3_init(-2.0, 2.0, -3.0), // position
+    rwm_v3_init(0.0f, 0.0f, 1.0f), // color
+    600.0f, // intensity
+  });
 
 #if 1
   world->lights.push_back({