diff --git a/README.md b/README.md index 323ce44..c17c7e8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,42 @@ -# VulkanCraft -Attempt to recreate CubeWorld with Vulkan +# R3D Engine -Vulkan SDK https://vulkan.lunarg.com/ -GLFW3 http://www.glfw.org/download.html -GLM https://glm.g-truc.net/0.9.9/index.html -stb_image.h https://github.com/nothings/stb/blob/master/stb_image.h +R3D Engine est un moteur de rendu graphique qui s'appuie sur Vulkan. L'objectif est d'en apprendre +plus sur les moteurs de rendu et leur fonctionnement. C'est également l'occasion de découvrir Vulkan. + +## Installation + +### Dépendences + +#### Vulkan SDK +Téléchargez le version 1.2.131.2 de [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) et installez la. + +Rien n'empêche d'utiliser une version supérieur ou ulterieur, mais ce n'est pas garranti que le projet compilera. + +#### GLFW3 +Téléchargez le version 3.3.2 de [GLFW version 3](https://www.glfw.org/) et décompressez le fichier. + +#### GLM +Téléchargez la dernière version disponible de [GLM](https://glm.g-truc.net/0.9.9/index.html) et décompressez le fichier. + +#### stb_image +Téléchargez la dernière version disponible de [stb](https://github.com/nothings/stb) depuis github. Vous pouvez supprimez tout les fichiers à l'exception +de stb_image.h. + +stb_image sera ammené a être implementer directement dans le projet. + +#### tiny object loader +Téléchargez la dernière version disponible de [tiny object loader](https://github.com/syoyo/tinyobjloader) depuis github. + +tiny object loader sera ammené a être remplacé. + +### Configuration du projet + +Le projet a été développé et testé par Visual Studio uniquement. Il est donc recommander d'utiliser cet IDE. +Dans le dossier script/, lancez setup.bat à l'aide d'un terminal. + +Trois nouvelles variables environnements que vous devrez modifié. + +GLM_PATH : chemin vers votre installation de GLM +GLFW_PATH : chemin vers votre installation de GLFW +R3DLIB_PATH : chemin vers votre installation de vos include supplémentaire +ASSIMP_PATH : chemin vers votre installation de ASSIMP \ No newline at end of file