From 9e5fb9532bc2d6fb51f660cc2ba7f9ecef4d6613 Mon Sep 17 00:00:00 2001 From: Stephen Birarda Date: Mon, 23 Feb 2015 09:11:06 -0800 Subject: [PATCH] clear up BUILD guide for optional external projects --- BUILD.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/BUILD.md b/BUILD.md index 6cfe5229d6..98b8cffab1 100644 --- a/BUILD.md +++ b/BUILD.md @@ -13,6 +13,13 @@ * [gverb](https://github.com/highfidelity/gverb) * [Soxr](http://sourceforge.net/projects/soxr/) ~> 0.1.1 +The following external projects are optional dependencies. You can indicate to CMake that you would like to include them by passing -DGET_$NAME=1 when running a clean CMake build. For example, to get CMake to download and compile QXmpp you would pass -DGET_QXMPP=1. + +* [SDL2](https://www.libsdl.org/download-2.0.php) ~> 2.0.3 + * Enables game controller support in Interface +* [QXmpp](https://github.com/qxmpp-project/qxmpp) ~> 0.7.6 + * Enables text chat support in Interface + The above dependencies will be downloaded, built, linked and included automatically by CMake where we require them. The CMakeLists files that handle grabbing each of the following external dependencies can be found in the [cmake/externals folder](cmake/externals). The resulting downloads, source files and binaries will be placed in the `build-ext` directory in each of the subfolders for each external project. These are not placed in your normal build tree when doing an out of source build so that they do not need to be re-downloaded and re-compiled every time the CMake build folder is cleared. Should you want to force a re-download and re-compile of a specific external, you can simply remove that directory from the appropriate subfolder in `build-ext`. Should you want to force a re-download and re-compile of all externals, just remove the `build-ext` folder. @@ -67,12 +74,6 @@ In the examples below the variable $NAME would be replaced by the name of the de ###Optional Components -####QXmpp - -You can [find QXmpp here](https://github.com/qxmpp-project/qxmpp), 0.7.6 is the version you want. The inclusion of the QXmpp enables text chat in the Interface client. - -OS X users who tap our [homebrew formulas repository](https://github.com/highfidelity/homebrew-formulas) can install QXmpp via homebrew - `brew install highfidelity/formulas/qxmpp`. - ####Devices You can support external input/output devices such as Oculus Rift, Leap Motion, Faceshift, PrioVR, MIDI, Razr Hydra and more by adding each individual SDK in the visible building path. Refer to the readme file available in each device folder in [interface/external/](interface/external) for the detailed explanation of the requirements to use the device.