Skip to content

Updated build docs to mention git submodules. #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
digisomni merged 2 commits into from
Aug 11, 2022
Merged

Updated build docs to mention git submodules. #1686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3521c50
Updated build docs to mention git submodules.
namark Aug 5, 2022
acbf1e7
Merge branch 'master' into build-doc-clone-submodule
namark Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions BUILD_LINUX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ You can use the [Vircadia Builder](https://github.com/vircadia/vircadia-builder)
This guide focuses on Ubuntu 18.04 only.

### Ubuntu 18.04 Server only
Add the universe repository:
Add the universe repository:
_(This is not enabled by default on the server edition.)_
```bash
sudo add-apt-repository universe
sudo apt-get update
```

### Install build tools
- First update the repositories:
- First update the repositories:
```bash
sudo apt-get update -y
sudo apt-get upgrade -y
Expand Down Expand Up @@ -93,9 +93,9 @@ sudo apt-get install nodejs

### Get code and checkout the branch you need

Clone this repository:
Clone this repository, including submodules:
```bash
git clone https://github.com/vircadia/vircadia.git
git clone --recursive https://github.com/vircadia/vircadia.git
```

Then checkout the master branch with:
Expand Down Expand Up @@ -136,7 +136,7 @@ Prepare makefiles:
cmake ..
```

If cmake fails with a vcpkg error, then delete `~/vircadia-files/vcpkg/`.
If cmake fails with a vcpkg error, then delete `~/vircadia-files/vcpkg/`.

#### Vircadia Server

Expand Down Expand Up @@ -189,7 +189,7 @@ Go to "localhost" in the running Interface to visit your newly launched Domain s
## Arch Linux

### Install build tools:
- First update the system:
- First update the system:
```bash
sudo pacman -Syu
```
Expand Down Expand Up @@ -275,9 +275,9 @@ sudo pacman -S unzip

### Get code and checkout the branch you need

Clone this repository:
Clone this repository, including submodules:
```bash
git clone https://github.com/vircadia/vircadia.git
git clone --recursive https://github.com/vircadia/vircadia.git
```

Enter the repository folder:
Expand Down Expand Up @@ -370,7 +370,7 @@ Go to "localhost" in the running Interface to visit your newly launched Domain s

### vcpkg

If your goal is to set up a development environment, it is desirable to set the directory
If your goal is to set up a development environment, it is desirable to set the directory
that vcpkg builds into with the `HIFI_VCPKG_BASE` environment variable.
For example, you might set `HIFI_VCPKG_BASE` to `/home/$USER/vcpkg`.

Expand All @@ -379,7 +379,7 @@ By default, vcpkg will build in the `~/vircadia-files/vcpkg/` directory.
### Architecture support

If the build is intended to be packaged for distribution, the `VIRCADIA_CPU_ARCHITECTURE`
CMake variable needs to be set to an architecture specific value. For example you can set
CMake variable needs to be set to an architecture specific value. For example you can set
it to `-msse3`. This will help ensure that the build can run on all reasonably modern CPUs.

By default, it is set to `-march=native -mtune=native`, which yields builds optimized for a particular
Expand Down
14 changes: 10 additions & 4 deletions BUILD_WIN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,13 @@ To create this variable:
* Set "Variable name" to `QT_CMAKE_PREFIX_PATH`
* Set "Variable value" to `%QT_INSTALL_DIR%\5.15.2\msvc2019_64\lib\cmake`, where `%QT_INSTALL_DIR%` is the directory you specified for Qt's installation. The default is `C:\Qt`.

## Step 6. Create VCPKG environment variable
## Step 6. Clone the Vircadia repository.
Clone the project repository, including submodules. This can be done with a single command in git bash:
```bash
git clone --recursive https://github.com/vircadia/vircadia.git
```

## Step 7. Create VCPKG environment variable
In the next step, you will use CMake to build Vircadia. 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:
Expand All @@ -77,7 +83,7 @@ To create this variable:
* Set "Variable name" to `HIFI_VCPKG_BASE`
* Set "Variable value" to any directory that you have control over.

## Step 7. Running CMake to Generate Build Files
## Step 8. Running CMake to Generate Build Files

Run Command Prompt from Start and run the following commands:
`cd "%VIRCADIA_DIR%"`
Expand All @@ -89,15 +95,15 @@ Run `cmake .. -G "Visual Studio 16 2019" -A x64`.

Where `%VIRCADIA_DIR%` is the directory for the Vircadia repository.

## Step 8. Making a Build
## Step 9. Making a Build

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.

Run from the menu bar `Build > Build Solution`.

## Step 9. Testing Interface
## Step 10. Testing Interface

Create another environment variable (see Step #3)
* Set "Variable name": `_NO_DEBUG_HEAP`
Expand Down