From d8c1af4ac2d6ef0bdb057be4d67f8f250958e416 Mon Sep 17 00:00:00 2001
From: O1LER <44237025+O1LER@users.noreply.github.com>
Date: Thu, 14 Nov 2024 21:38:33 +0100
Subject: [PATCH] Add linux building instructions

---
 README.md | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4ade1bec..da5ff7a5 100755
--- a/README.md
+++ b/README.md
@@ -4,7 +4,9 @@ The launcher is the way we communitcate to outside the game, it does a few autom
 
 **To clone this repository**: `git clone --recurse-submodules https://github.com/BeamMP/BeamMP-Launcher.git`
 
-## How to build - Release
+## How to build for Windows
+
+### Release
 
 In the root directory of the project,
 1. `cmake -DCMAKE_BUILD_TYPE=Release . -B bin -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static`
@@ -12,10 +14,41 @@ In the root directory of the project,
 
 Remember to change `C:/vcpkg` to wherever you have vcpkg installed.
 
-## How to build - Debug
+### Debug
 
 In the root directory of the project,
 1. `cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static`
 2. `cmake --build bin --parallel`
 
 Remember to change `C:/vcpkg` to wherever you have vcpkg installed.
+
+## How to build for Linux
+
+Make sure you have the necessary development tools installed
+
+- Debian: `sudo apt install build-essential`
+- Fedora: `sudo dnf groupinstall "Development Tools"`
+- Arch: `sudo pacman -S base-devel`
+- openSUSE: `zypper in -t pattern devel-basis`
+
+### Release
+
+In the root directory of the project,
+1. `cmake -DCMAKE_BUILD_TYPE=Release . -B bin -DCMAKE_TOOLCHAIN_FILE=/~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux`
+2. `cmake --build bin --parallel --config Release`
+
+Remember to change `/~/vcpkg` to wherever you have vcpkg installed.
+
+### Debug
+
+In the root directory of the project,
+1. `cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=/~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux`
+2. `cmake --build bin --parallel`
+
+Remember to change `/~/vcpkg` to wherever you have vcpkg installed.
+
+## Running out of RAM while building
+
+Should you run out of RAM while building, you can ommit the `--parallel` intruction, it will then use less RAM due to building only on one CPU thread.
+
+You can also specify a number of threads to use, for example `--parallel 4` will use four CPU threads, but due to the small project size, you may be faster just omitting `--parallel` instead of trying to find the highest possible multithread number