Cinder + Git

Cinder

Cinder + Git

If you're interested in keeping up with the latest Cinder development or contributing to the project (yes please!) then you'll definitely want to setup a clone of Cinder's git repository. Cinder's home on Github is at http://github.com/cinder.


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.7.2.3-intel-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 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.7.2.3-preview20100911.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 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.

Downloading Boost

You'll also need to download the same Boost version Cinder is built against, currently version 1.44, which you can download here. After dearchiving it, take the resulting directory, put it in your Cinder directory and rename it boost. You don't need to build Boost, but these headers are necessary to build Cinder. It is also possible to copy the boost directory from one of our prepackaged Cinder releases as a shortcut.


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 cinder\vc10\cinder.sln (or cinder\vc9\cinder.sln if you are still using Visual C++ 2008). Under the Build menu select Batch Build, and click the checkboxes corresponding to both the Debug and Release build configurations, and then hit the Build button. If you don't have a Batch Build menu item, make sure you have Visual C++ in expert mode, which is toggled under the menu item Tools | Settings | Expert Settings.



This will take a second, but once everything succeeds, the files cinder.lib and cinder_d.lib 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 opencv

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.