How to build the source on Windows

How to design and create applications with ApertusVR

First Steps

Download and install the following programs:

Create or open a folder for the ApertusVR source code, here open Git Bash or any Git GUIs.

In case of Git Bash copy the following into the command prompt and press enter:

$ git clone -b master --single-branch https://github.com/MTASZTAKI/ApertusVR.git

Otherwise, choose Clone Existing Repositorya and copy the following into the Source Location:

git clone -b master --single-branch https://github.com/MTASZTAKI/ApertusVR.git

Choose a Target Directory and click Clone. When the cloning finished close Git.

Open CMake

Click Browse Source... and select ApertusVR folder. Than click Browse Build... and select a folder for the binaries.

Click Generate and select Visual Studio 15 2017 Win64, then click Finish.

After the process completed close CMake.

Open the folder where the binaries were built

Here can be found the apertusVR.sln file.

aperusVR.sln

Open it with Visual Studio, set the Solution configuration to release and build the project.

set to release
build the solution

CMake

The source code of ApertusVR uses CMAKE, which gives you the opportunity to use an IDE or platform of your choice.

Git

The "master" branch is considered stable, at all times. The "develop" branch is the one where all contributions must be merged before being promoted to master. If you plan to propose a patch, please pull-request it into the "develop" branch, or its own feature branch. Direct commit to "master" are not permitted.

C++ coding style

The #define Guard

All header files should have #define guards to prevent multiple inclusion. The format of the symbol name should be <APE>_<PLUGINNAME>_H.

#ifndef APE_TESTERPLUGIN_H
#define APE_TESTERPLUGIN_H
...
#endif // APE_TESTERPLUGIN_H