From e7dd7d13d3e74b1a654620588a331ae8e7d2472c Mon Sep 17 00:00:00 2001 From: fintmc Date: Sun, 6 Oct 2024 14:05:21 +0300 Subject: [PATCH] Add CMake build instructions --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index f31e968..7ada9ee 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,29 @@ A Minecraft clone made in C++ and OpenGL ## How to Run To run the game, download the ScuffedMinecraft zip file from the [latest release](https://github.com/EvanatorM/ScuffedMinecraft/releases/latest), unzip the file, and run ScuffedMinecraft.exe. The assets folder must be in the same place as the exe file. + +## Building + +### Building with Visual Studio +Import the project in Visual Studio 17 or higher and build it. + +### Building with CMake +In the project root directory: +Create CMake files: +```sh +mkdir -p build +cd build +cmake ../ScuffedMinecraft +``` +After that you can build the project using: +```sh +cmake --build ./build +``` +Run the build command in the project root directory. + +The final executable can be found at `(project root)/ScuffedMinecraft/bin` + +#### Note for building with CMake +If you're running from a command line, make sure to run +the executable in the same directory as it is located +to ensure all resources are loaded properly.