Building

Building on UNIX

$ cd <clone>
$ mkdir build
$ cd build
$ cmake ../src
$ cmake --build . -- -j 8

Mac OS X System Requirements

Linux System Requirements

Solaris System Requirements

Building on Windows

$ cd <clone>
$ mkdir build
$ cd build
$ cmake ../src
$ cmake --build . -- /m

Windows System Requirements

Generator

CMake uses a “generator” to produce configuration files for use by a variety of build tools, e.g., UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake during configuration. (Please see the CMake documentation for further information.) However, in many cases there is a better choice.

Mac OS X Generator

The recommended generator on Mac OS X is Xcode:

$ cmake -G "Xcode" ../src

Windows Generator

The recommended generator on Windows is Visual Studio 12 2013 Win64:

$ cmake -G "Visual Studio 12 2013 Win64" ../src

Finding Geode

Building requires access to an installation of Geode. By default the value of GEODE_ROOT or GEODE is used during CMake configuration if either of those shell variables is exported. To explicitly specify the location in which Geode is installed, add -DGEODE_ROOT=/path/to/geode to the initial cmake execution command before ../src.

Installing

By default a system-specific location is used by CMake as the destination of the install target, e.g., /usr/local on UNIX system. To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to the initial cmake execution command before ../src.

Due to limitations in CMake, the documentation must be built as a separate step before installation:

$ cd <clone>
$ cd build
$ cmake --build . --target docs
$ cmake --build . --target install

System Requirements

All Platforms

Required Tools

  • CMake 4.3 or newer
  • C++11 compiler (see platform specific requirements)
  • Doxygen 8.11 (for building source documentation)

Mac OS X

  • Mac OS X 10.12 (Sierra)

Required Tools

  • XCode

  • Xcode command line developer tools

    $ xcode-select --install

Optional Tools

Windows

  • Windows 8.1 64-bit
  • Windows 10 64-bit
  • Windows Server 2012 64-bit
  • Windows Server 2012 R2 64-bit

Required Tools

Linux

  • RHEL/CentOS 6
  • RHEL/CentOS 7
  • SLES 11
  • SLES 12

Required Tools

Optional Tools

Solaris

  • Solaris 10 SPARC
  • Solaris 10 x86
  • Solaris 11 SPARC
  • Solaris 11 x86

Required Tools