From c4d9dd300bd69fe8218c7a1abb69efacc7ee664b Mon Sep 17 00:00:00 2001 From: Chewico Date: Wed, 2 Jul 2025 22:18:08 +0200 Subject: [PATCH] Updated README.md compile steps --- README.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 21a6725..5158617 100755 --- a/README.md +++ b/README.md @@ -16,44 +16,57 @@ You can check out Premake at: ### Clone the repo -```console -git clone https://git.frostdeer.com/Chewico/DeerEngine.git -cd Deer +```bash +git clone --recursive https://git.frostdeer.com/Chewico/DeerEngine.git +cd DeerEngine ``` ### Generating Project Files -As we mentioned we need to generate the make files with premake, to do this you can install the premake bin or compile it as we will mention +Install dependencies (if you haven't already): -```console +```bash +sudo apt-get update sudo apt-get install uuid-dev make gcc +``` + +Build Premake from source: + +```bash cd vendor/premake-core make -f Bootstrap.mak linux cd ../.. ``` -```console +Generate Makefiles: + +```bash vendor/premake-core/bin/release/premake5 gmake ``` -If you want to generate vscode workspace use +If you want to generate a VSCode workspace, run: -```console -./vendor/premake-core/bin/release/premake5 vscode +```bash +vendor/premake-core/bin/release/premake5 vscode ``` ### Compile -Run +Before compiling, ensure you have the necessary dependencies installed: -```console +```bash sudo apt update -sudo apt install clang libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libgtk-3-dev make gcc gdb -sudo make +sudo apt install clang libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libgtk-3-dev gdb +``` + +Then compile the project: + +```bash +make ``` ### Run -```console +```bash ./bin/linux-x86_64/Debug/DeerStudio/DeerStudio ```