BeamMP/BeamMP-Launcher
1
0
Fork 0
mirror of https://github.com/BeamMP/BeamMP-Launcher.git synced 2025-07-03 08:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update build instructions (#156)

Browse Source 
Update build instructions

Adresses both #155 and #153 

---

By creating this pull request, I understand that code that is AI
generated or otherwise automatically generated may be rejected without
further discussion.
I declare that I fully understand all code I pushed into this PR, and
wrote all this code myself and own the rights to this code.
This commit is contained in:
Tixx 2024-12-14 18:19:06 +01:00 committed by GitHub
commit 096d07fe9b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,6 +6,10 @@ The launcher is the way we communitcate to outside the game, it does a few autom
## How to build for Windows ## How to build for Windows
Make sure you have the necessary development tools installed:
[vcpkg](https://vcpkg.io/en/)
### Release ### Release
In the root directory of the project, In the root directory of the project,
@ -24,7 +28,7 @@ Remember to change `C:/vcpkg` to wherever you have vcpkg installed.
## How to build for Linux ## How to build for Linux
Make sure you have the necessary development tools installed Make sure you have `vcpkg` installed, as well as basic development tools, often found in packages, for example:
- Debian: `sudo apt install build-essential` - Debian: `sudo apt install build-essential`
- Fedora: `sudo dnf groupinstall "Development Tools"` - Fedora: `sudo dnf groupinstall "Development Tools"`
@ -34,19 +38,15 @@ Make sure you have the necessary development tools installed
### Release ### Release
In the root directory of the project, 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` 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` 2. `cmake --build bin --parallel --config Release`
Remember to change `/~/vcpkg` to wherever you have vcpkg installed.
### Debug ### Debug
In the root directory of the project, In the root directory of the project,
1. `cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=/~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux` 1. `cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=~/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux`
2. `cmake --build bin --parallel` 2. `cmake --build bin --parallel`
Remember to change `/~/vcpkg` to wherever you have vcpkg installed.
## Running out of RAM while building ## 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. 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.