CU Computer Graphics Group Hack Night

This is the codebase used for Hack Nights of CU Computer Graphics Group. Our goal is building a whitted ray tracer together during club meetings.

Tools needed to compile

A C++ 17 compiler

Recent version of Visual Studio, GCC, or Clang should be find.

CMake 3.8+

CMake is the build tool used for this projects. The minimum CMake version requirement is 3.8.

Conan

Conan is the package manager this project use. The easiest way to install conan is through pip:

$ pip install conan

(Optional) Ninja

Ninja can significantly improve the incremental build time. Can be used as a target for CMake.

(Optional) CPPCheck

Download cppcheck here. CPPCheck is a static analyze tool with very few false positive.

(Optional) Clang tool chains

Download clang here. This projects use clang-tidy and clang-format for linting.

Build and run

After installing all the tools, we can build and run this project:

mkdir build
cd build
conan install .. # Install dependencies
cmake .. # Generate target for CMake, you can pass parameters to CMake here

After generate the building script, you can compile your project from there. There are no platform dependent way of doing that. If you generate ninja target, you should be able to use ninja command in the build folder to compile. If you generate a Makefile, use make command in the build folder.

Note every time you reconfig the CMakeList.txt, you need to run cmake command again.