Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-06 23:32:57 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update BUILD_WIN.md

Browse source 
Added pip install distro command step.
This commit is contained in:
kasenvr 2020-01-13 18:01:48 -05:00 committed by GitHub
parent 1133f51971
commit a297d7d735
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
BUILD_WIN.md
View file

@ -29,14 +29,20 @@ If you already have Visual Studio installed and need to add Python, open the "Ad
If you do not wish to use the Python installation bundled with Visual Studio, you can download the installer from [here](https://www.python.org/downloads/). Ensure you get version 3.6.6 or higher. If you do not wish to use the Python installation bundled with Visual Studio, you can download the installer from [here](https://www.python.org/downloads/). Ensure you get version 3.6.6 or higher.
### Step 2. Installing CMake ### Step 2. Python Dependencies
In a command-line that can access Python's pip you will need to run the following command:
`pip install distro`
### Step 3. Installing CMake
Download and install the latest version of CMake 3.15. Download and install the latest version of CMake 3.15.
* Note that earlier versions of CMake will work, but there is a specific bug related to the interaction of Visual Studio 2019 and CMake versions prior to 3.15 that will cause Visual Studio to rebuild far more than it needs to on every build * Note that earlier versions of CMake will work, but there is a specific bug related to the interaction of Visual Studio 2019 and CMake versions prior to 3.15 that will cause Visual Studio to rebuild far more than it needs to on every build
Download the file named win64-x64 Installer from the [CMake Website](https://cmake.org/download/). You can access the installer on this [3.15 Version page](https://cmake.org/files/v3.15/). During installation, make sure to check "Add CMake to system PATH for all users" when prompted. Download the file named win64-x64 Installer from the [CMake Website](https://cmake.org/download/). You can access the installer on this [3.15 Version page](https://cmake.org/files/v3.15/). During installation, make sure to check "Add CMake to system PATH for all users" when prompted.
### Step 3. Create VCPKG environment variable ### Step 4. Create VCPKG environment variable
In the next step, you will use CMake to build Project Athena. By default, the CMake process builds dependency files in Windows' `%TEMP%` directory, which is periodically cleared by the operating system. To prevent you from having to re-build the dependencies in the event that Windows clears that directory, we recommend that you create a `HIFI_VCPKG_BASE` environment variable linked to a directory somewhere on your machine. That directory will contain all dependency files until you manually remove them. In the next step, you will use CMake to build Project Athena. By default, the CMake process builds dependency files in Windows' `%TEMP%` directory, which is periodically cleared by the operating system. To prevent you from having to re-build the dependencies in the event that Windows clears that directory, we recommend that you create a `HIFI_VCPKG_BASE` environment variable linked to a directory somewhere on your machine. That directory will contain all dependency files until you manually remove them.
To create this variable: To create this variable:
@ -55,7 +61,7 @@ To create this variable:
* Set "Variable name" to `HIFI_VCPKG_BOOTSTRAP` * Set "Variable name" to `HIFI_VCPKG_BOOTSTRAP`
* Set "Variable value" to `1` * Set "Variable value" to `1`
### Step 4. Running CMake to Generate Build Files ### Step 5. Running CMake to Generate Build Files
Run Command Prompt from Start and run the following commands: Run Command Prompt from Start and run the following commands:
`cd "%HIFI_DIR%"` `cd "%HIFI_DIR%"`
@ -70,7 +76,7 @@ Run `cmake .. -G "Visual Studio 16 2019" -A x64`.
Where `%HIFI_DIR%` is the directory for the highfidelity repository. Where `%HIFI_DIR%` is the directory for the highfidelity repository.
### Step 5. Making a Build ### Step 6. Making a Build
Open `%HIFI_DIR%\build\athena.sln` using Visual Studio. Open `%HIFI_DIR%\build\athena.sln` using Visual Studio.
@ -78,7 +84,7 @@ Change the Solution Configuration (menu ribbon under the menu bar, next to the g
Run from the menu bar `Build > Build Solution`. Run from the menu bar `Build > Build Solution`.
### Step 6. Testing Interface ### Step 7. Testing Interface
Create another environment variable (see Step #3) Create another environment variable (see Step #3)
* Set "Variable name": `_NO_DEBUG_HEAP` * Set "Variable name": `_NO_DEBUG_HEAP`