CONGE-1 - added support for bat files and README.md
This commit is contained in:
parent
77084729d8
commit
6ffd75fb04
27
README.md
Normal file
27
README.md
Normal file
@ -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/
|
||||
2
debug.bat
Executable file
2
debug.bat
Executable file
@ -0,0 +1,2 @@
|
||||
@Run Conan to install dependencies
|
||||
conan install . -s build_type=Debug --build=missing
|
||||
2
release.bat
Executable file
2
release.bat
Executable file
@ -0,0 +1,2 @@
|
||||
@ Run Conan to install dependencies
|
||||
conan install . -s build_type=Release --build=missing
|
||||
Loading…
x
Reference in New Issue
Block a user