diff --git a/BUILD_OSX.md b/BUILD_OSX.md index b39aadb287..9b3316240c 100644 --- a/BUILD_OSX.md +++ b/BUILD_OSX.md @@ -1,6 +1,6 @@ # Build OSX -*Last Updated on April 30, 2019* +*Last Updated on July 3, 2020* Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only macOS specific instructions are found in this document. @@ -15,14 +15,21 @@ Please read the [general build guide](BUILD.md) for information on dependencies Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/). Execute the `Update Shell Profile.command` script that is provided with the installer. +### npm + +Install npm via `brew install npm`, as it is needed for generating the included jsdocs. + +### OSX SDK + +You will need the OSX SDK for building. The easiest way to get this is to install Xcode from the App Store. + ### 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. -For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR: +For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR via + `export OPENSSL_ROOT_DIR=/usr/local/opt/openssl` + or by appending `-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl` to cmake - export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2l - -Note that 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. @@ -34,3 +41,7 @@ If `cmake` complains about Python 3 being missing, you may need to update your C 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}/Debug` directories. + +### make + +If you build with make rather than Xcode, you can append `-j4`for assigning more threads. The number indicates the number of threads, e.g. 4.