CGUL is currently undergoing a lot of development and has no official builds, and the following is subject to change and only covers rather broad setup instructions.

Building and installing CGUL

First we need to obtain the latest source code from github (some functionality may be missing) git clone https://github.com/Zethes/CGUL cd CGUL

CGUL uses third-party libraries and those must be handled before we can build. Luckily for you, we have provided several choices for you to download pre-built libraries on the Download page. Just download the dependency of your choosing and extract the archive into CGUL's directory (Above the 'src' directory).

CGUL's build process is powered by CMake and we recommend you build outside of the source directory. mkdir build && cd build cmake -G <BUILD_TYPE> .. make && make install

CMake provides an easy way to provide cross-compilation on many machines without having to write individual build files. For more information on what to put in for <BUILD_TYPE> see http://www.cmake.org/Wiki/CMake_Generator_Specific_Information for more information.

Building the examples

YOU MUST HAVE BUILT AND INSTALLED CGUL TO BUILD THE EXAMPLES

At the moment, each example must be built seperately. These steps are the same for all examples and are very similar to building CGUL itself.

Begin by simply navigating to the desired example's directory inside the terminal of your choosing. For this example we'll be using the window example. git clone https://github.com/Zethes/CGUL cd CGUL/examples cd Graphics/window

Similar to building CGUL, we recommend building outside of the source directory. mkdir build && cd build cmake -G <BUILD_TYPE> .. make

You should now have an executable file inside your current work directory for the example.