getting started

Getting Started with Kohi

TODO

Introduction

TODO

Required Workstation Setup

You will need to have Clang and the Vulkan SDK installed:

• Clang: https://releases.llvm.org/download.html
• Vulkan SDK: https://vulkan.lunarg.com/
• Git (Windows: https://git-scm.com/download/win, Mac/Linux can install this using your preferred package manager)

I also use VS Code in the series: https://code.visualstudio.com/download

Cloning the Repository

To download the code, run the following in command prompt or terminal:

git clone https://github.com/travisvroman/kohi

Building the Codebase

If using VS Code, open the kohi folder in VS Code and press ctrl+shift+b to build.

Otherwise, open a command prompt or terminal, browse to the kohi root directory and run:

• Windows: build-all.bat then post-build.bat
• Linux: ./build-all.sh then ./post-build.sh
• Mac: ./build-all-macos.sh then ./post-build-mac.sh.

The executables and libraries will be placed in bin, and intermediate files will be placed in obj.

See the setup videos in the series for Windows or Linux for details.

Cleaning (for a full rebuild)

There are also clean scripts available: clean-all.bat (Windows), clean-all.sh (Linux) and clean-all-mac.sh (Mac). These wipe out associated files in the bin and obj folders, triggering a full compile on the next build.

Running Kohi

If using VS Code, press F5 to run the program. Otherwise, browse to the bin folder and run the appropriate executable file.

See Also

Home Page