Build on Windows

Prerequisites:

• Windows 10 x64 (x86 will not be supported at this time)
  
• Either:
  • Visual Studio 2019 w/ "Desktop development with C++" Workload,
  • Visual Studio 2022 w/ "Desktop development with C++" Workload, OR
  • Build Tools for Visual Studio 2019/2022 w/ "Desktop development with C++" Workload
• CMake 3.19 or above (note: Do not use the included one with Visual Studio at this time! It is outdated as of this time of writing and is considered incompatible.)
• Vulkan SDK 1.3.211
• Git for Windows

Now, there are multiple methods for building in Windows.
Please choose your path:

• Command Line

• Visual Studio 2022

Building with Command Line

---

Checking your environment

For Windows, building with a command line interface can be pretty simple once your system is set up properly!
For starters, please be sure that your tools are located in either your User or System PATH environment variable - a simple test to check this would be to enter the following command into your CLI: cl
If all goes well, you should see something similar to the following output:

Microsoft (R) C/C++ Optimizing Compiler Version 19.34.31931 for x86
Copyright (C) Microsoft Corporation.  All rights reserved.

usage: cl [ option... ] filename... [ /link linkoption... ]

If you do not see something similar to this, you will want to most likely open and use either Developer Command Prompt for VS 2019/2022 or Developer Powershell for VS 2019/2022 depending on what version of Visual Studio (or the Build Tools) you have installed. Otherwise, if you're certain that your system is set up properly, you can continue on with building.

Building

Let's get into it, shall we?

1. First, clone the repository into a folder of your choice (by default, this will create and clone into a NovelRT folder):

git clone https://github.com/NovelRT/NovelRT.git

2. Navigate into the newly created folder:

cd NovelRT

3. Create a build directory to hold all of the build output, and then navigate inside of said directory:

mkdir build
cd build

4. Time to configure! Configure NovelRT by running the following command via CMake:

cmake ..

5. Finally, to build everything, run the following CMake command:

cmake --build . -j

If all ends well, you should successfully build NovelRT, its Interop library, as well as all of NovelRT's sample programs and Tests. Congratulations!

Building with VS2022

---

This document assumes that you have already installed the prerequisites listed above, as well as Visual Studio 2022. With that said, we'll jump right into building.

Building

1. First, open Visual Studio 2022 - at the startup window that appears, select the Clone a Repository option.

[TO BE CONTINUED]