Skip to content

Commit

Permalink
Updated README.md to list dependencies and goal
Browse files Browse the repository at this point in the history
  • Loading branch information
Chais committed Mar 19, 2016
1 parent cf6dda0 commit 2862820
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# RayTracer
A whitted ray tracer written in C++

This project mainly serves the purposes of making me more familiar with C++ as well as getting me into computer graphics.
This project mainly serves the purposes of making me more familiar with C++ as well as getting me into computer graphics. I hope though, that it is helpful and/or educational for others too and I try to keep the code understandable, rather than highly performant.

It is written in C++11 and thus requires a compiler capable of that standard. It uses CImg for image import and export, which at least depends on X11 and pthread libraries. CImg dependencies are handled in its own `.cmake` file. It further depends on [PugiXML](https://github.com/zeux/pugixml) for XML parsing and uses [TinyOBJLoader](https://github.com/syoyo/tinyobjloader) as in-tree library.

0 comments on commit 2862820

Please sign in to comment.