diff --git a/BUILD.md b/BUILD.md index 8d70d1ed..2443ac56 100644 --- a/BUILD.md +++ b/BUILD.md @@ -4,7 +4,7 @@ Full build instructions will be available on [the website](https://prismlauncher If you would like to contribute or fix an issue with the Build instructions you will be able to do so [here](https://github.com/PrismLauncher/website/blob/master/src/wiki/development/build-instructions.md). -

Getting the source

+## Getting the source Clone the source code using git, and grab all the submodules. This is generic for all platforms you want to build on. ``` @@ -12,10 +12,10 @@ git clone --recursive https://github.com/PrismLauncher/PrismLauncher cd PrismLauncher ``` -

Linux

+## Linux This guide will mostly mention dependant packages by their Debian naming and commands are done by a user in the sudoers file. -

Dependencies

+### Dependencies - A C++ compiler capable of building C++17 code (can be found in the package `build-essential`). - Qt Development tools 5.12 or newer (on Debian 11 or Debian-based distributions, `qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5`). @@ -32,8 +32,8 @@ In conclusion, to check if all you need is installed (including optional): sudo apt install build-essential qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5 cmake extra-cmake-modules zlib1g-dev openjdk-17-jdk libgl1-mesa-dev scdoc ``` -

Compiling

-

Building and installing on the system

+### Compiling +#### Building and installing on the system This is usually the suggested way to build the client. ``` @@ -42,7 +42,7 @@ cmake --build build -j$(nproc) sudo cmake --install build ``` -

Building a portable binary

+#### Building a portable binary ``` cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install