Skip to content

Commit 3b2bdb3

Browse files
committed
Add build instructions
1 parent 48651f7 commit 3b2bdb3

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

BUILDING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Building
2+
3+
## Windows
4+
5+
Prerequsites:
6+
* Installation of Visual Studio Build Tools
7+
* CMake (available with VS Build Tools)
8+
* vcpkg (available with VS Build Tools)
9+
* `VCPKG_ROOT` environment variable pointing at vcpkg installation folder
10+
11+
### With CMake CLI
12+
With Developer PowerShell open at root folder of this project run:
13+
```pwsh
14+
cmake -Bbuild -S. -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-windows-static-md
15+
cmake --build build
16+
```
17+
Resulting binary will be located at `build/src/System/Debug/ArrowVortex.exe`
18+
19+
To install ArrowVortex to a folder run:
20+
```pwsh
21+
cmake --install build --prefix "<your_folder_here>"
22+
```
23+
24+
### With Visual Studio
25+
1. Run `vcpkg integrate install` in Developer PowerShell. This will integrate vcpkg with your installation of Visual Studio and needs to be run once.
26+
2. Open root folder of this project in Visual Studio
27+
28+
29+
## Troubleshooting
30+
### CMake can't find freetype
31+
CMake failed to integrate with vcpkg. Remove your build directory (either `build/` or `out/`) and follow instructions for your system.

0 commit comments

Comments
 (0)