From 7633361bb4b9025fe386efcc0b2338fadd1d18d4 Mon Sep 17 00:00:00 2001 From: Kasen IO Date: Sun, 17 May 2020 22:38:22 -0400 Subject: [PATCH] Update build docs. --- BUILD.md | 33 ++++++++++++++++++++++++++------- BUILD_WIN.md | 6 +++--- INSTALL.md | 2 +- 3 files changed, 30 insertions(+), 11 deletions(-) diff --git a/BUILD.md b/BUILD.md index f441290c85..594fc973a6 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,6 +1,6 @@ # General Build Information -*Last Updated on December 21, 2019* +*Last Updated on May 17, 2020* ### OS Specific Build Guides @@ -36,7 +36,7 @@ These are not placed in your normal build tree when doing an out of source build #### CMake -Athena uses CMake to generate build files and project files for your platform. +Vircadia uses CMake to generate build files and project files for your platform. #### Qt CMake will download Qt 5.12.3 using vcpkg. @@ -49,9 +49,9 @@ This can either be entered directly into your shell session before you build or export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.12.3/lib/cmake export QT_CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake -#### Vcpkg +#### VCPKG -Athena uses vcpkg to download and build dependencies. +Vircadia uses vcpkg to download and build dependencies. You do not need to install vcpkg. Building the dependencies can be lengthy and the resulting files will be stored in your OS temp directory. @@ -61,7 +61,26 @@ export HIFI_VCPKG_BASE=/path/to/directory Where /path/to/directory is the path to a directory where you wish the build files to get stored. -#### Generating build files +#### Generating Build Files + +##### Possible Environment Variables + + CMAKE_BACKTRACE_URL + CMAKE_BACKTRACE_TOKEN + + RELEASE_NUMBER + BUILD_NUMBER + + RELEASE_TYPE=PRODUCTION|PR + RELEASE_BUILD=PRODUCTION|PR + + PRODUCTION_BUILD=0|1 + STABLE_BUILD=0|1 + + USE_STABLE_GLOBAL_SERVICES=1 + BUILD_GLOBAL_SERVICES=STABLE + +##### Generate 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. @@ -69,7 +88,7 @@ Create a build directory in the root of your checkout and then run the CMake bui cd build cmake .. -If cmake gives you the same error message repeatedly after the build fails, try removing `CMakeCache.txt`. +If CMake gives you the same error message repeatedly after the build fails, try removing `CMakeCache.txt`. #### Variables @@ -83,7 +102,7 @@ For example, to pass the QT_CMAKE_PREFIX_PATH variable (if not using the vcpkg'e 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). -You can point our [Cmake find modules](cmake/modules/) to the correct version of dependencies by setting one of the three following variables to the location of the correct version of the dependency. +You can point our [CMake find modules](cmake/modules/) to the correct version of dependencies by setting one of the three following variables to the location of the correct version of the dependency. In the examples below the variable $NAME would be replaced by the name of the dependency in uppercase, and $name would be replaced by the name of the dependency in lowercase (ex: OPENSSL_ROOT_DIR, openssl). diff --git a/BUILD_WIN.md b/BUILD_WIN.md index 098553c761..0c4c0d3d25 100644 --- a/BUILD_WIN.md +++ b/BUILD_WIN.md @@ -1,6 +1,6 @@ # Build Windows -*Last Updated on April 7, 2020* +*Last Updated on May 17, 2020* This is a stand-alone guide for creating your first Vircadia build for Windows 64-bit. @@ -82,7 +82,7 @@ Where `%VIRCADIA_DIR%` is the directory for the Vircadia repository. ### Step 6. Making a Build -Open `%VIRCADIA_DIR%\build\athena.sln` using Visual Studio. +Open `%VIRCADIA_DIR%\build\vircadia.sln` using Visual Studio. Change the Solution Configuration (menu ribbon under the menu bar, next to the green play button) from "Debug" to "Release" for best performance. @@ -116,4 +116,4 @@ Remove `CMakeCache.txt` found in the `%VIRCADIA_DIR%\build` directory. #### CMake can't find OpenSSL -Remove `CMakeCache.txt` found in the `%VIRCADIA_DIR%\build` directory. Verify that your HIFI_VCPKG_BASE environment variable is set and pointing to the correct location. Verify that the file `${HIFI_VCPKG_BASE}/installed/x64-windows/include/openssl/ssl.h` exists. +Remove `CMakeCache.txt` found in the `%VIRCADIA_DIR%\build` directory. Verify that your HIFI_VCPKG_BASE environment variable is set and pointing to the correct location. Verify that the file `${HIFI_VCPKG_BASE}/installed/x64-windows/include/openssl/ssl.h` exists. diff --git a/INSTALL.md b/INSTALL.md index 10858200e7..fff8112607 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -60,7 +60,7 @@ To produce an executable installer on Windows, the following are required: 1. Install version 10.15.0 LTS 1. Perform a clean cmake from a new terminal. -1. Open the `athena.sln` solution and select the Release configuration. +1. Open the `vircadia.sln` solution and select the Release configuration. 1. Build the solution. 1. Build `packaged-server-console-npm-install` (found under **hidden/Server Console**) 1. Build `packaged-server-console` (found under **Server Console**)