Cinder + Git

Cinder

Cinder + Git

If you're interested in keeping up with the latest Cinder development you'll want to setup a clone of Cinder's git repository. Cinder's home on Github is at http://github.com/cinder.


In general Cinder's active development is done in the dev branch, so that's the one we'll setup below. The master branch is designed to reflect minor updates to the latest official release.

Installing Git on Mac OS X

If you don't already have Git installed on your Mac, start by downloading the Git installer here (at the time of this writing, the file git-1.8.2-intel-universal-snow-leopard.dmg was the latest installer).


Run the installer with the default settings and then launch Terminal. Navigate to the directory where you'd like to create the repository and run this command:


git clone -b dev --recursive git://github.com/cinder/Cinder.git cinder_master


If you aren't familiar with git, the only command you need to remember is git pull which, when executed from your new cinder_master directory, will update your copy of Cinder. Doing forget to rebuild Cinder (described below) whenever you do this.

Installing Git on Windows

If you don't already have Git installed on your PC, start by downloading the Git installer here (at the time of this writing, the file Git-1.8.1.2-preview20130201.exe was the latest installer).


When prompted by the installer, we recommend that you select the Use Git Bash only option for Adjusting your PATH environment. For line-ending configurations, we also recommend the default, Checkut windows-style, commit Unix-style. Once you've got Git installed, launch the Git Bash application. Navigate to the directory where you would like to setup Cinder, and execute the command:


git clone -b dev --recursive git://github.com/cinder/Cinder.git cinder_master


If you aren't familiar with git, the only command you need to remember is git pull which, when executed from your new cinder_master directory, will update your copy of Cinder. Doing forget to rebuild Cinder (described below) whenever you do this.

Building on Mac OS X

The most straightforward way to build both the Debug and Release configurations of the Mac OS X, iOS and iOS Simulator targets is to run the script located at cinder/xcode/fullbuild.sh

cd xcode
./fullbuild.sh


Building on Windows

To build Cinder on Windows, first make sure you've got the rest of your development environment setup as described in the Windows Setup document. Next, open up the Visual Studio solution in either cinder\vc10\cinder.sln or cinder\vc11\cinder.sln depending on whether you're working from Visual C++ 2010 (vc10) or Visual C++ 2012 (vc11). You'll build as you would any Visual C++ project, and don't forget to build both Debug and Release.


After your build completes, the files cinder.lib (for Release) and cinder_d.lib (for Debug) will be created at the path cinder\libs.

OpenCV

Cinder's support for OpenCV is maintained separately from the primary distribution due to its size. To setup OpenCV support, cd to your blocks directory and execute the command below:
cd blocks
git clone git://github.com/cinder/Cinder-OpenCV.git

Generating Documentation

As a final step, if you'd like to have a local copy of the Cinder documentation, you can generate it using Doxygen. If you don't already have it installed, you can download the latest Doxygen release here. After installing it, simply open the file cinder/docs/doxygen/Doxyfile and hit Run. After some processing, you'll have a local copy of the docs, which you can open at cinder/docs/html/index.html.