OS X Build Guide

Overview

Please read the general build guide for information on dependencies required for all platforms. Only OS X specific instructions are found in this file.

Homebrew

Homebrew is an excellent package manager for OS X. It makes the installation of some High Fidelity dependencies very simple.

brew install cmake openssl qt

Python 3

Download an install of Python 3.6.6 or higher from here. Execute the Update Shell Profile.command script that is provided with the installer.

OpenSSL

Assuming you've installed OpenSSL using the Homebrew instructions above, you'll need to set OPENSSL_ROOT_DIR so CMake can find your installations.

export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2l

This uses the version from the Homebrew formula at the time of this writing, and the version in the path will likely change.

Qt

Assuming you've installed Qt using the Homebrew instructions above, you'll need to set QT_CMAKE_PREFIX_PATH so CMake can find your installations.

export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt/5.10.1/lib/cmake

This uses the version from the Homebrew formula at the time of this writing, and the version in the path will likely change.

Xcode

If Xcode is your editor of choice, you can ask CMake to generate Xcode project files instead of Unix Makefiles.

cmake .. -G Xcode

If CMake complains that Python 3 is missing, you may need to update your CMake binary with the command brew upgrade cmake, or by downloading and running the latest CMake installer, depending on how you originally installed CMake.

After running CMake, you will have the make files or Xcode project file necessary to build all of the components. Open the hifi.xcodeproj file, choose ALL_BUILD from the Product > Scheme menu (or target drop down), and click Run.

If the build completes successfully, you will have built targets for all components located in the build/${target_name}/Debugdirectories.