fix: Update the README

This commit is contained in:
Edo 2023-12-01 16:14:51 +01:00 committed by GitHub
parent 24f26ef3a5
commit fca6dea60e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,11 +5,11 @@
This is the master server our clients use. It is based on the DP Master Server (ID Tech) protocol This is the master server our clients use. It is based on the DP Master Server (ID Tech) protocol
## Build ## Build
- Install [*premake5*](https://premake.github.io) and add it to your system PATH - Install [*Premake5*](https://premake.github.io) and add it to your system PATH
- Clone this repository - Clone this repository
- Update the submodules using ``git submodule update --init --recursive`` - Update the submodules using ``git submodule update --init --recursive``
- Run Premake with either of these two options ``premake5 vs2022`` (Windows) or ``premake5 gmake2`` (Linux/macOS) - Run Premake with either of these two options ``premake5 vs2022`` (Windows) or ``premake5 gmake2`` (Linux/macOS)
**IMPORTANT** **IMPORTANT**
For Unix systems, you must use Clang to compile this project. You will also be required to install the LLVM C++ Standard library to run this program. For Unix systems, you must use Clang to compile this project. You will also be required to install the LLVM C++ Standard library to run this program.
If you need to use another compiler, like GCC, you will be required to use the [Mold](https://github.com/rui314/mold) linker. Additionally, you must tweak the Premake5.lua script as it's hardcoded to use Clang. If you need to use another compiler, like GCC, you will be required to use the [Mold](https://github.com/rui314/mold) linker. Additionally, you must tweak the Premake5.lua script as it's hardcoded to use Clang.