diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b5cee8 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# 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. + +### Debug +1. Execute `./debug.sh` (LINUX/MAC) or `.\debug.bat` (WINDOWS) +2. Load CMakeUserPresets.json that was created during step 1 +3. You should be able to build the different subprojects +4. The binaries are available in bin/ + +### Release +1. Execute `./release.sh` (LINUX/MAC) or `.\release.bat` (WINDOWS) +2. Load CMakeUserPresets.json that was created during step 1 +3. You should be able to build the different subprojects +4. The binaries are available in bin/ \ No newline at end of file diff --git a/debug.bat b/debug.bat new file mode 100755 index 0000000..0988e26 --- /dev/null +++ b/debug.bat @@ -0,0 +1,2 @@ +@Run Conan to install dependencies +conan install . -s build_type=Debug --build=missing diff --git a/release.bat b/release.bat new file mode 100755 index 0000000..13ca3dc --- /dev/null +++ b/release.bat @@ -0,0 +1,2 @@ +@ Run Conan to install dependencies +conan install . -s build_type=Release --build=missing