Rim/master-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

maint: Add some useful information to the README

Browse Source
This commit is contained in:
Edo 2023-12-01 16:14:13 +01:00 committed by GitHub
parent baf4bd64a6
commit 24f26ef3a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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.