Building requires access to an installation of Geode. There are two ways to achieve this:
GEODE_HOME that points to your Geode installation path.GEODE_ROOT during the CMake configuration step.-DGEODE_ROOT=/path/to/geode to the initial cmake execution command.$ cd <clone> $ mkdir build $ cd build # configuration step $ cmake .. <platform-specific generator parameters (see below)> # build step $ cmake --build . -- <platform-specific parallelism parameters (see below)>
If OpenSSL is installed in a custom location, then you must pass OPENSSL_ROOT_DIR during the CMake configuration step. For example, -DOPENSSL_ROOT_DIR=/path/to/openssl.
To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to this initial cmake execution command.
To set the version header on the API docs, specify PRODUCT_VERSION on the configuration command line. For example, -DPRODUCT_VERSION=1.2.3.
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.
The recommended generator for most unix platforms is ‘Makefiles’ (default):
$ cmake ..
Install XCode from the App Store
xcode-select --install from terminalInstall the required dependencies through homebrew. If you use another package manager for your mac feel free to use that.
$ brew install geode
$ brew install openssl
$ brew install doxygen
$ brew install cmake
You will need to provide the path to the brew installed OpenSSL headers since macOS already has a system installed version but without the required headers.
$ cmake .. -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
For Visual Studio 2017 and newer you only need to specify the correct architecture, toolset and SDK for Windows. To build a 64-bit library using the 64 bit toolset version 14.1 with minimum ABI compatibility of 14.16 for minimum Windows version 10.0.16299.0 use the following options.
$ cmake .. -A x64 -Tv141,version=14.16,host=x64 -DCMAKE_SYSTEM_VERSION=10.0.16299.0
At a bare minimum you will likely need to specify the architecture, since MSVC still defaults to 32 bit, and the 64 bit version of the toolset, because of large object files. The latest toolset version and Windows SDK will likely get picked up.
$ cmake .. -A x64 -Thost=x64
For faster builds, use optional parallelism parameters in the last build step:
$ cmake --build . -- -j <# of jobs>
$ cmake --build . -- /m
IPv6 support can be enabled by adding -DWITH_IPV6=ON to the CMake Generator command.
$ cmake … -DWITH_IPV6=ON …
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.
Note: For consistent results, avoid using the “~” (tilde) abbreviation when specifying paths on the CMake command line. Interpretation of the symbol varies depending on the option being specified, and on the system or command shell in use.
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
Other distributions and versions may be supported given C++11 compatible compiler and runtime library.
Older versions of macOS or Mac OS X and Xcode may work but are not regularly tested or developed on.
$ xcode-select --install
Solaris is not actively developed or tested. While no effort has been made to remove Solaris support it is likely broken.