Building V3D

Requirements for building

1. Msys2

2. GCC 11.2.0 (tested on this, but might also work with previous versions), you can check if it is already installed in your machine by running
   

   gcc --version
   

   OR

   g++ --version
   

   If this isn't already installed, run the following in MSYS2 MinGW shell

   pacman -S gcc
   

3. GNU Make 4.3, you can check if it is already installed, though it already comes with mingw64 binutils package, by running

   make --version
   

   If this isn't already installed, run the following in MSYS2 MinGW shell

   pacman -S make
   

4. Git version 2.35.1, git must be installed in your machine, you can check if it is already installed by running
   

   git --version
   

   If this isn't already installed, run the following in MSYS2 MinGW shell

   pacman -S git
   

5. glslc, glslc can be installed as follows, run the following in MSYS2 MinGW shell
   

   pacman -S mingw-w64-x86_64-shaderc
   

Runtime requirements

1. Windows 64 bit
2. GPU supporting vulkan api (integrated or discrete)
3. Main memory (RAM) - No data as of now
4. Disk space - No data as of now
5. Better to have Vulkan LunarG SDK installed for additional debugging and vulkan configuration (validation layers), but it is not a requirement because the static library and headers are already included in the repository and would be updated as new updates will come in future.

Building steps

1. Clone the repository by running the following command
   

   git clone https://github.com/ravi688/VulkanRenderer.git
   

2. Change the working directory to VulkanRenderer and setup all the dependency git submodules by running the following command

   cd VulkanRenderer
   make -s setup
   make -s update
   

3. Start building by running the following command

   make -s build
   

   OR

   make -s build-debug
   

   For release mode

   make -s build-release
   

Building executable manually (Optional)

1. Change the working directory to VulkanRenderer and build the main.exe executable by running the following command

   make -s debug
   

2. Now run the main.exe executable by running the following command

   main.exe
   

Cleaning everything (Optional)

1. Change the working directory to VulkanRenderer and run the following command

   make -s clean