diff --git a/README.md b/README.md index f901dfe..ef92cda 100644 --- a/README.md +++ b/README.md @@ -50,9 +50,7 @@ You can find precompiled binaries under [Releases](https://github.com/BeamMP/Bea ## Build Instructions -**__Do not compile from `master`. Always build from a release tag, i.e. `tags/v2.3.3`!__** - -Currently only linux and windows are supported (generally). See [Releases](https://github.com/BeamMP/BeamMP-Server/releases/) for official binary releases. On systems to which we do not provide binaries (so anything but windows), you are allowed to compile the program and use it. Other restrictions, such as not being allowed to distribute those binaries, still apply (see [copyright notice](#copyright)). +[See here!](#how-to-build) ### Prerequisites @@ -60,7 +58,7 @@ Currently only linux and windows are supported (generally). See [Releases](https Please use the prepackaged binaries in [Releases](https://github.com/BeamMP/BeamMP-Server/releases/). -Dependencies for **windows** can be installed with `vcpkg`. +Dependencies for **windows** can be installed with [`vcpkg`](https://github.com/microsoft/vcpkg). These are: ``` > vcpkg install lua zlib rapidjson openssl websocketpp curl @@ -70,13 +68,14 @@ These are: These package names are in the debian / ubuntu style. Feel free to PR your own guide for a different distro. -Runtime dependencies for **linux** are (debian/ubuntu): +Runtime dependencies for **linux**: + +**Debian / Ubuntu** ```shell $ sudo apt install libz-dev rapidjson-dev liblua5.3 libssl-dev libwebsocketpp-dev libcurl4-openssl-dev git make cmake g++ ``` - -For other distributions (e.g. Arch) you want to find packages for: +For other distributions (e.g. **Arch**) you want to find packages for: - libz - rapidjson - lua5.3