From 092daa4256fc8666eed543988568079686166c4f Mon Sep 17 00:00:00 2001 From: Edo Date: Thu, 14 Dec 2023 17:23:26 +0100 Subject: [PATCH] maint(readme): use bullet points --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fd2d679..53d7ea3 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,20 @@ 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 +- Install [Premake5](premake5-link) and add it to your system PATH +- Clone this repository using [Git][git-link] - 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 must use the [Mold](https://github.com/rui314/mold) linker. Additionally, you may have to tweak the Premake5.lua script. -I only support a few platforms, for more details see [build.yml](https://github.com/alterware/master-server/blob/master/.github/workflows/build.yml) +Requirements for Unix systems: +- Compilation: Please use Clang as the preferred compiler +- Dependencies: Ensure the LLVM C++ Standard library is installed +- Alternative compilers: If you opt for a different compiler such as GCC, use the [Mold][mold-link] linker +- Customization: Modifications to the Premake5.lua script may be required +- Platform support: Details regarding supported platforms are available in [build.yml][build-link] + +[premake5-link]: https://premake.github.io +[git-link]: https://git-scm.com +[mold-link]: https://github.com/rui314/mold +[build-link]: https://github.com/alterware/master-server/blob/master/.github/workflows/build.yml