From 24f26ef3a5186a22e56d6d11f104328457fcd33f Mon Sep 17 00:00:00 2001 From: Edo Date: Fri, 1 Dec 2023 16:14:13 +0100 Subject: [PATCH] maint: Add some useful information to the README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b7a88d8..cc4cf44 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,14 @@ # AlterWare: Master Server +This is the master server our clients use. It is based on the DP Master Server (ID Tech) protocol + +## Build +- Install [*premake5*](https://premake.github.io) and add it to your system PATH +- Clone this repository +- 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) + + **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. + 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.