visual headers

BUILD.md

@@ -1,4 +1,4 @@
-###Dependencies
+### Dependencies
 
 * [cmake](https://cmake.org/download/) ~> 3.3.2
 * [Qt](https://www.qt.io/download-open-source) ~> 5.6.2
@@ -6,7 +6,7 @@
   * IMPORTANT: Use the latest available version of OpenSSL to avoid security vulnerabilities.
 * [VHACD](https://github.com/virneo/v-hacd)(clone this repository)(Optional)
 
-####CMake External Project Dependencies
+#### CMake External Project Dependencies
 
 * [boostconfig](https://github.com/boostorg/config) ~> 1.58
 * [Bullet Physics Engine](https://github.com/bulletphysics/bullet3/releases) ~> 2.83
@@ -30,16 +30,19 @@ These are not placed in your normal build tree when doing an out of source build
 
 If you would like to use a specific install of a dependency instead of the version that would be grabbed as a CMake ExternalProject, you can pass -DUSE_LOCAL_$NAME=0 (where $NAME is the name of the subfolder in [cmake/externals](cmake/externals)) when you run CMake to tell it not to get that dependency as an external project.
 
-###OS Specific Build Guides
+### OS Specific Build Guides
+
 * [BUILD_OSX.md](BUILD_OSX.md) - additional instructions for OS X.
 * [BUILD_LINUX.md](BUILD_LINUX.md) - additional instructions for Linux.
 * [BUILD_WIN.md](BUILD_WIN.md) - additional instructions for Windows.
 * [BUILD_ANDROID.md](BUILD_ANDROID.md) - additional instructions for Android
 
-###CMake
+### CMake
+
 Hifi uses CMake to generate build files and project files for your platform.
 
-####Qt
+#### Qt
+
 In order for CMake to find the Qt5 find modules, you will need to set a QT_CMAKE_PREFIX_PATH environment variable pointing to your Qt installation.
 
 This can either be entered directly into your shell session before you build or in your shell profile (e.g.: ~/.bash_profile, ~/.bashrc, ~/.zshrc - this depends on your shell and environment).
@@ -50,7 +53,8 @@ The path it needs to be set to will depend on where and how Qt5 was installed. e
     export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.6.2/lib/cmake
     export QT_CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake
 
-####Generating build files
+#### Generating build files
+
 Create a build directory in the root of your checkout and then run the CMake build from there. This will keep the rest of the directory clean.
 
     mkdir build
@@ -59,14 +63,15 @@ Create a build directory in the root of your checkout and then run the CMake bui
 
 If cmake gives you the same error message repeatedly after the build fails (e.g. you had a typo in the QT_CMAKE_PREFIX_PATH that you fixed but the `.cmake` files still cannot be found), try removing `CMakeCache.txt`.
 
-####Variables
+#### Variables
+
 Any variables that need to be set for CMake to find dependencies can be set as ENV variables in your shell profile, or passed directly to CMake with a `-D` flag appended to the `cmake ..` command.
 
 For example, to pass the QT_CMAKE_PREFIX_PATH variable during build file generation:
 
     cmake .. -DQT_CMAKE_PREFIX_PATH=/usr/local/qt/5.6.2/lib/cmake
 
-####Finding Dependencies
+#### Finding Dependencies
 
 The following applies for dependencies we do not grab via CMake ExternalProject (OpenSSL is an example), or for dependencies you have opted not to grab as a CMake ExternalProject (via -DUSE_LOCAL_$NAME=0). The list of dependencies we grab by default as external projects can be found in [the CMake External Project Dependencies section](#cmake-external-project-dependencies).
 
@@ -78,8 +83,8 @@ In the examples below the variable $NAME would be replaced by the name of the de
 * $NAME_ROOT_DIR - set this variable in your ENV
 * HIFI_LIB_DIR - set this variable in your ENV to your High Fidelity lib folder, should contain a folder '$name'
 
-###Optional Components
+### Optional Components
 
-####Devices
+#### Devices
 
 You can support external input/output devices such as Leap Motion, MIDI, 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.

BUILD_ANDROID.md

@@ -1,6 +1,6 @@
 Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only Android specific instructions are found in this file.
 
-###Android Dependencies
+### Android Dependencies
 
 You will need the following tools to build our Android targets.
 
@@ -17,23 +17,23 @@ You will need the following tools to build our Android targets.
 
 You will also need to cross-compile the dependencies required for all platforms for Android, and help CMake find these compiled libraries on your machine.
 
-####Scribe
+#### Scribe
 
 High Fidelity has a shader pre-processing tool called `scribe` that various libraries will call on during the build process. You must compile scribe using your native toolchain (following the build instructions for your platform) and then pass a CMake variable or set an ENV variable `SCRIBE_PATH` that is a path to the scribe executable.
 
 CMake will fatally error if it does not find the scribe executable while using the android toolchain.
 
-####Optional Components
+#### Optional Components
 
 * [Oculus Mobile SDK](https://developer.oculus.com/downloads/#sdk=mobile) ~> 0.4.2
 
-####ANDROID_LIB_DIR
+#### ANDROID_LIB_DIR
 
 Since you won't be installing Android dependencies to system paths on your development machine, CMake will need a little help tracking down your Android dependencies.
 
 This is most easily accomplished by installing all Android dependencies in the same folder. You can place this folder wherever you like on your machine. In this build guide and across our CMakeLists files this folder is referred to as `ANDROID_LIB_DIR`. You can set `ANDROID_LIB_DIR` in your environment or by passing when you run CMake.
 
-####Qt
+#### Qt
 
 Install Qt 5.5.1 for Android for your host environment from the [Qt downloads page](http://www.qt.io/download/). Install Qt to ``$ANDROID_LIB_DIR/Qt``. This is required so that our root CMakeLists file can help CMake find your Android Qt installation.
 
@@ -41,7 +41,7 @@ The component required for the Android build is the `Android armv7` component.
 
 If you would like to install Qt to a different location, or attempt to build with a different Qt version, you can pass `ANDROID_QT_CMAKE_PREFIX_PATH` to CMake. Point to the `cmake` folder inside `$VERSION_NUMBER/android_armv7/lib`. Otherwise, our root CMakeLists will set it to `$ANDROID_LIB_DIR/Qt/5.5/android_armv7/lib/cmake`.
 
-####OpenSSL
+#### OpenSSL
 
 Cross-compilation of OpenSSL has been tested from an OS X machine running 10.10 compiling OpenSSL 1.0.2. It is likely that the steps below will work for other OpenSSL versions than 1.0.2.
 
@@ -76,7 +76,7 @@ This should generate libcrypto and libssl in the root of the OpenSSL directory.
 
 If you have been building other components it is possible that the OpenSSL compile will fail based on the values other cross-compilations (tbb, bullet) have set. Ensure that you are in a new terminal window to avoid compilation errors from previously set environment variables.
 
-####Oculus Mobile SDK
+#### Oculus Mobile SDK
 
 The Oculus Mobile SDK is optional, for Gear VR support. It is not required to compile gvr-interface.
 
@@ -91,7 +91,7 @@ ndk-build
 
 This will create the liboculus.a archive that our FindLibOVR module will look for when cmake is run.
 
-#####Hybrid testing
+##### Hybrid testing
 
 Currently the 'vr_dual' mode that would allow us to run a hybrid app has limited support in the Oculus Mobile SDK. The best way to have an application we can launch without having to connect to the GearVR is to put the Gear VR Service into developer mode. This stops Oculus Home from taking over the device when it is plugged into the Gear VR headset, and allows the application to be launched from the Applications page.
 
@@ -99,7 +99,7 @@ To put the Gear VR Service into developer mode you need an application with an O
 
 Once the application is on your device, go to `Settings->Application Manager->Gear VR Service->Manage Storage`. Tap on `VR Service Version` six times. It will scan your device to verify that you have an osig file in an application on your device, and then it will let you enable Developer mode.
 
-###CMake
+### CMake
 
 We use CMake to generate the makefiles that compile and deploy the Android APKs to your device. In order to create Makefiles for the Android targets, CMake requires that some environment variables are set, and that other variables are passed to it when it is run.
 

BUILD_LINUX.md

@@ -1,6 +1,7 @@
 Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only Linux specific instructions are found in this file.
 
-###Qt5 Dependencies
+### Qt5 Dependencies
+
 Should you choose not to install Qt5 via a package manager that handles dependencies for you, you may be missing some Qt5 dependencies. On Ubuntu, for example, the following additional packages are required:
 
     libasound2 libxmu-dev libxi-dev freeglut3-dev libasound2-dev libjack0 libjack-dev libxrandr-dev libudev-dev libssl-dev

BUILD_OSX.md

@@ -1,12 +1,13 @@
 Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only OS X specific instructions are found in this file.
 
-###Homebrew
+### Homebrew
+
 [Homebrew](https://brew.sh/) is an excellent package manager for OS X. It makes install of some High Fidelity dependencies very simple.
 
     brew tap homebrew/versions
     brew install cmake openssl
 
-###OpenSSL
+### 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:
@@ -15,7 +16,8 @@ For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR:
 
 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.
 
-###Qt
+### Qt
+
 Download and install the [Qt 5.6.2 for macOS](http://download.qt.io/official_releases/qt/5.6/5.6.2/qt-opensource-mac-x64-clang-5.6.2.dmg). 
 
 Keep the default components checked when going through the installer.
@@ -23,7 +25,8 @@ Keep the default components checked when going through the installer.
 Once Qt is installed, you need to manually configure the following:
 * Set the QT_CMAKE_PREFIX_PATH environment variable to your `Qt5.6.2/5.6/clang_64/lib/cmake/` directory.
 
-###Xcode
+### Xcode
+
 If Xcode is your editor of choice, you can ask CMake to generate Xcode project files instead of Unix Makefiles.
 
     cmake .. -GXcode

INSTALL.md

@@ -2,15 +2,15 @@ Follow the [build guide](BUILD.md) to figure out how to build High Fidelity for
 
 During generation, CMake should produce an `install` target and a `package` target.
 
-###Install
+### Install
 
 The `install` target will copy the High Fidelity targets and their dependencies to your `CMAKE_INSTALL_PREFIX`.
 
-###Packaging
+### Packaging
 
 To produce an installer, run the `package` target.
 
-####Windows
+#### Windows
 
 To produce an executable installer on Windows, the following are required:
 
@@ -20,6 +20,6 @@ To produce an executable installer on Windows, the following are required:
 
 Run the `package` target to create an executable installer using the Nullsoft Scriptable Install System.
 
-####OS X
+#### OS X
 
 Run the `package` target to create an Apple Disk Image (.dmg).