Beginner's guide

On this page you will find an introduction to get KoRE running on your platform.

Requirements:

• Git
• CMake
• OpenGL, GLEW, GLFW

Step 1: Setup

• Setup up Git and CMake dependent to your platform so that they can be accessed via command line.
• Setup OpenGL, GLFW and GLEW (see OpenGL Help).

Step 2: Get KoRE

To work with KoRE you will need to clone the online sources to your local storage. Preferably you would first fork the main KoRE repository to your own GitHub repository (see GitHub documentation).

• Create a folder with a name that indicates the repository which you are going to clone into that folder. Let us call that folder REPO_ROOT.
• In your command tool, navigate to REPO_ROOT and type git clone URL-TO-REPOSITORY, that is git clone https://github.com/KoRE0/KoRE.git in case of the KoRE main repository.
• Git will start downloading the repository and create a folder REPO_ROOT/KoRE
• When finished, unpack the dependencies for your platform included in REPO_ROOT/KoRE (Will be available at http://userpages.uni-koblenz.de/~cg/KoRE/ in future)

Step 3: CMake

To create makefiles or project files for a certain IDE (like Eclipse or Visual Studio) CMake has to be run.

• Navigate into REPO_ROOT/KoRE and type cmake. A list of available options will appear.
• Find your preferred option and type cmake -G "OPTION". For example, Eclipse developers using MinGW on Windows would enter cmake -G "Eclipse CDT4 - MinGW Makefiles".
• Done! KoRE is now ready to compile and use.