From 944f4c96ae9451d1fbec8ffc438559d39ff54b7f Mon Sep 17 00:00:00 2001 From: amerhifi <43353902+amerhifi@users.noreply.github.com> Date: Tue, 5 Feb 2019 11:14:52 -0800 Subject: [PATCH] New build file for Quest new build file specific to the quest device --- build_quest.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 build_quest.md diff --git a/build_quest.md b/build_quest.md new file mode 100644 index 0000000000..e093969f83 --- /dev/null +++ b/build_quest.md @@ -0,0 +1,65 @@ +Please read the [general build guide](BUILD.md) for information on building other platform. Only Quest specific instructions are found in this file. + +# Dependencies + +Building is currently supported on OSX, Windows and Linux platforms, but developers intending to do work on the library dependencies are strongly urged to use 64 bit Linux as a build platform + +You will need the following tools to build Android targets. + +* [Android Studio](https://developer.android.com/studio/index.html) + +### Android Studio + +Download the Android Studio installer and run it. Once installed, at the welcome screen, click configure in the lower right corner and select SDK manager + +From the SDK Platforms tab, select API levels 24 and 26. + +From the SDK Tools tab select the following + +* Android SDK Build-Tools +* GPU Debugging Tools +* CMake (even if you have a separate CMake installation) +* LLDB +* Android SDK Platform-Tools +* Android SDK Tools +* NDK (even if you have the NDK installed separately) + +Make sure the NDK installed version is 18 (or higher) + +# Environment + +Setting up the environment for android builds requires some additional steps + +#### Set up machine specific Gradle properties + +Create a `gradle.properties` file in $HOME/.gradle. Edit the file to contain the following + + HIFI_ANDROID_PRECOMPILED=/Android/hifi_externals + HIFI_ANDROID_KEYSTORE=/.jks + HIFI_ANDROID_KEYSTORE_PASSWORD= + HIFI_ANDROID_KEY_ALIAS= + HIFI_ANDROID_KEY_PASSWORD= + +Note, do not use `$HOME` for the path. It must be a fully qualified path name. + +### Setup the repository + +Clone the repository + +`git clone https://github.com/highfidelity/hifi.git` + +Enter the repository `android` directory + +`cd hifi/android` + +# Building & Running + +* Open Android Studio +* Choose _Open Existing Android Studio Project_ +* Navigate to the `hifi` repository and choose the `android` folder and select _OK_ +* Open Gradle.settings and comment out any projects not necessary +* From _File_ menu select _Sync with File System_ to resync Gradle settings +* From the _Build_ menu select _Make Project_ +* From +* Once the build completes, from the _Run_ menu select _Run App_ +