From 7b2c48c8d467567243088fb3859f17d240a437e9 Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 14:04:09 +0100 Subject: [PATCH 1/6] Add some information about tags in the build instructions --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c59427b..3664a8a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you need support with understanding the codebase, please write us in the Disc ## About Building from Source -We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.1.0`. +We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags, as well as https://github.com/BeamMP/BeamMP-Server/releases to check which version is marked as a release/prerelease. We recommend to use the latest release https://github.com/BeamMP/BeamMP-Server/releases/latest ## Supported Operating Systems @@ -65,10 +65,11 @@ If you are building for ARM (like aarch64), you need to run `export VCPKG_FORCE_ You can build on **Windows, Linux** or other platforms by following these steps: 1. Check out the repository with git: `git clone --recursive https://github.com/BeamMP/BeamMP-Server`. -2. Go into the directory `cd BeamMP-Server`. -3. Run CMake `cmake -S . -B bin -DCMAKE_BUILD_TYPE=Release` - this can take a few minutes and may take a lot of disk space and bandwidth. -4. Build via `cmake --build bin --parallel --config Release -t BeamMP-Server`. -5. Your executable can be found in `bin/`. +2. Specify the server version to build by cheking out a tag: `git checkout tags/v3.4.1` - See https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags +3. Go into the directory `cd BeamMP-Server`. +4. Run CMake `cmake -S . -B bin -DCMAKE_BUILD_TYPE=Release` - this can take a few minutes and may take a lot of disk space and bandwidth. +5. Build via `cmake --build bin --parallel --config Release -t BeamMP-Server`. +6. Your executable can be found in `bin/`. When you make changes to the code, you only have to run step 4 again. ### Building for FreeBSD From dc3bb517a353053945aebf0b021fb1eeeb3d130e Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 14:29:48 +0100 Subject: [PATCH 2/6] Update README.md Co-authored-by: Tixx <83774803+WiserTixx@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3664a8a..76fb346 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ If you are building for ARM (like aarch64), you need to run `export VCPKG_FORCE_ You can build on **Windows, Linux** or other platforms by following these steps: 1. Check out the repository with git: `git clone --recursive https://github.com/BeamMP/BeamMP-Server`. -2. Specify the server version to build by cheking out a tag: `git checkout tags/v3.4.1` - See https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags +2. Specify the server version to build by checking out a tag: `git checkout tags/v3.4.1` - [Possible versions/tags](https://github.com/BeamMP/BeamMP-Server/tags) 3. Go into the directory `cd BeamMP-Server`. 4. Run CMake `cmake -S . -B bin -DCMAKE_BUILD_TYPE=Release` - this can take a few minutes and may take a lot of disk space and bandwidth. 5. Build via `cmake --build bin --parallel --config Release -t BeamMP-Server`. From 71038dc617803631fe0125dcdf8ef635f1dffd12 Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 14:32:47 +0100 Subject: [PATCH 3/6] Hide links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 76fb346..ed01cb6 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you need support with understanding the codebase, please write us in the Disc ## About Building from Source -We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags, as well as https://github.com/BeamMP/BeamMP-Server/releases to check which version is marked as a release/prerelease. We recommend to use the latest release https://github.com/BeamMP/BeamMP-Server/releases/latest +We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags] https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags, as well as [the releases] https://github.com/BeamMP/BeamMP-Server/releases to check which version is marked as a release/prerelease. We recommend to use the [latest release] https://github.com/BeamMP/BeamMP-Server/releases/latest ## Supported Operating Systems From 52ad2374193b10b52f7915e6f69859b12d0b6fe6 Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 14:33:52 +0100 Subject: [PATCH 4/6] Fix bracket skill issue --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed01cb6..4aff30b 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you need support with understanding the codebase, please write us in the Disc ## About Building from Source -We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags] https://github.com/BeamMP/BeamMP-Server/tags for possible versions/tags, as well as [the releases] https://github.com/BeamMP/BeamMP-Server/releases to check which version is marked as a release/prerelease. We recommend to use the [latest release] https://github.com/BeamMP/BeamMP-Server/releases/latest +We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags] (https://github.com/BeamMP/BeamMP-Server/tags) for possible versions/tags, as well as [the releases] (https://github.com/BeamMP/BeamMP-Server/releases) to check which version is marked as a release/prerelease. We recommend to use the [latest release] (https://github.com/BeamMP/BeamMP-Server/releases/latest) ## Supported Operating Systems From 6ce0608bb38659f0285c4c608b67e623f83c3c0b Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 14:35:17 +0100 Subject: [PATCH 5/6] Third times the charm --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4aff30b..b674da5 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you need support with understanding the codebase, please write us in the Disc ## About Building from Source -We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags] (https://github.com/BeamMP/BeamMP-Server/tags) for possible versions/tags, as well as [the releases] (https://github.com/BeamMP/BeamMP-Server/releases) to check which version is marked as a release/prerelease. We recommend to use the [latest release] (https://github.com/BeamMP/BeamMP-Server/releases/latest) +We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags](https://github.com/BeamMP/BeamMP-Server/tags) for possible versions/tags, as well as [the releases](https://github.com/BeamMP/BeamMP-Server/releases) to check which version is marked as a release/prerelease. We recommend to use the [latest release](https://github.com/BeamMP/BeamMP-Server/releases/latest) ## Supported Operating Systems From c696276fc3c15c9199de798f29aee36b83223902 Mon Sep 17 00:00:00 2001 From: O1LER <44237025+O1LER@users.noreply.github.com> Date: Sat, 2 Nov 2024 23:30:22 +0100 Subject: [PATCH 6/6] Update README.md Co-authored-by: Tixx <83774803+WiserTixx@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b674da5..f934d9f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ If you need support with understanding the codebase, please write us in the Disc ## About Building from Source -We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags](https://github.com/BeamMP/BeamMP-Server/tags) for possible versions/tags, as well as [the releases](https://github.com/BeamMP/BeamMP-Server/releases) to check which version is marked as a release/prerelease. We recommend to use the [latest release](https://github.com/BeamMP/BeamMP-Server/releases/latest) +We only allow building unmodified (original) source code for public use. `master` is considered **unstable** and we will not provide technical support if such a build doesn't work, so always build from a tag. You can checkout a tag with `git checkout tags/TAGNAME`, where `TAGNAME` is the tag, for example `v3.4.1`. See [the tags](https://github.com/BeamMP/BeamMP-Server/tags) for possible versions/tags, as well as [the releases](https://github.com/BeamMP/BeamMP-Server/releases) to check which version is marked as a release/prerelease. We recommend using the [latest release](https://github.com/BeamMP/BeamMP-Server/releases/latest). ## Supported Operating Systems