HowToBuild
When building FARSIGHT for the first time you will need to set up a development environment. FARSIGHT utilizes several large source libraries so ensure that you have at least 25 GiB of HDD space.
Contents |
Choose a Compiler For Your OS
Popular choices are gcc/g++ on Linux, Microsoft Visual Studio 2008/2010 on Windows, and XCode* on Mac OS X.
*To install XCode/gcc on Mac OS X you may need to install the XCode development environment.
Install CMake
CMake is a tool which generates the makefiles under Linux, the Visual Studio Solution files (.sln) under Windows, or the XCode project files (.xcodeproj) under Mac OS X. It aims to allow developers to build their projects across different platforms with a minimum of reconfiguration.
Note: If you want to take advantage of multicore building in Visual Studio, you can append /MP to CMAKE_C_FLAGS and CMAKE_CXX_FLAGS at each CMake configuration screen.
Install Git
- Download [Git].
- When it ask for "Adjusting your PATH environment: How would you like to use Git from the command line", select: Run Git from the Windows Command Prompt.
- When it ask for "Configuring the line ending conversions: How should Git treat line endings in text files", select: Checkout Windows-style, commit Unix-style line endings.
Download FARSIGHT source code
FARSIGHT's Git Repository is located at:
https://github.com/RoysamLab/Farsight-toolkit.git
Build FARSIGHT
FARSIGHT depends on Qt, Boost, ITK, VTK, and VXL.
FARSIGHT's SuperBuild system can automatically download & build these dependencies for you.
Please follow the ManualBuild instructions if you'd prefer to setup these dependencies by hand.
What's next?
Checking the Quality Dashboard
When you start contributing code you can monitor if code and tests you build are compiling correctly on the dashboard machines here: http://cdash.org/CDash/index.php?project=Farsight
Submitting results to the Dashboard
You can also submit an experimental build or set up automated builds .
