Skip to content

Quick starting guide

djod4556 edited this page Nov 22, 2011 · 1 revision

This page is a quick starting guide to explain how to compile and launch the ray tracer.

Dependencies

The project depends of the following tools and libraries.

  • GNUmake
  • GCC toolchain (g++, ld, libc)
  • Simple DirectMedia Layer (SDL)

Build

The build tool chain is based on a Makefile. The project build under Linux (Unix ?) environments but have never been built under Windows. It should with little Makefile tweaks. To build the project, just type make into the root folder of the project. A build directory is created, containing the build products and the ray tracer application binary raytracer.

The tool chain can use another compiler like Clang++ for example. You'll just need to modify the Makefile to use it. All the compilation and link option are compatible with GCC (of course) and Clang.

Usage

The ray tracer use a XML file to describe the scene and display the result in a window. To launch the program with the example scene, use the following command in the root directory.

build/raytracer scene.xml

You can write a new scene file if you want, you'll just need to specify it when you launch the program.

Clone this wiki locally