conjure-engine/README.md

23 lines
744 B
Markdown

# Conjure Engine
## Installation
### Dependancies
To install this project, it is required that you install the folowind dependancies
on you computer:
- Vulkan SDK: https://vulkan.lunarg.com/sdk/home
- Conan 2: https://docs.conan.io/2/installation.html
### Platforms supported
- Mac 14+
- Windows 10+
- Linux 6+
Those are wide guideline and any version recent enough of your OS should work
as long it supports vulkan and conan.
### Installation step
#### Configure your IDE
1. Execute `./Configure.sh` (LINUX/MAC) or `.\Configure.bat` (WINDOWS). This step installs all the dependencies for both release and debug.
2. Load the generated CMakeUserPresets.json that was generated at step 1.
3. Select an executable project (like Demo1)
4. Build