From 6ffd75fb04d5c259faa083943f55a87ea2dd29eb Mon Sep 17 00:00:00 2001
From: Jimmy Tremblay-Bernier <jimmy.tremblay-bernier.1@ens.etsmtl.ca>
Date: Thu, 21 Nov 2024 10:11:03 -0500
Subject: [PATCH] CONGE-1 - added support for bat files and README.md

---
 README.md   | 27 +++++++++++++++++++++++++++
 debug.bat   |  2 ++
 release.bat |  2 ++
 3 files changed, 31 insertions(+)
 create mode 100644 README.md
 create mode 100755 debug.bat
 create mode 100755 release.bat

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