From fd51e5df47ddd3c358f3b1375ea1910036f59ec9 Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 15:35:40 +0200
Subject: Added build instructions for Linux
Added build instructions in the main repository as a temporary reference
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 41 +++++++++++++++++++++++++++++++++++++++--
1 file changed, 39 insertions(+), 2 deletions(-)
diff --git a/BUILD.md b/BUILD.md
index 4d9fb76f..41dd80e3 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -1,5 +1,42 @@
# Build Instructions
-Build instructions are available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
+Full build instructions will are available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
-If you would like to contribute or fix an issue with the Build instructions you can do so [here](https://github.com/PlaceholderMC/website/blob/master/src/wiki/development/build-instructions.md).
+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/PlaceholderMC/website/blob/master/src/wiki/development/build-instructions.md).
+
+
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.
+```
+git clone --recursive https://github.com/PlaceholderMC/PrismLauncher
+cd PrismLauncher
+```
+
+Linux
+
+This guide will mostly mention dependant packages by their Debian naming.
+Dependencies
+
+- A C++ compiler capable of building C++17 code.
+- 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`).
+- `cmake` 3.15 or newer.
+- `extra-cmake-modules`.
+- zlib (`zlib1g-dev` on Debian 11 or Debian-based distributions).
+- Java Development Kit (Java JDK) (`openjdk-17-jdk` on Debian 11 or Debian-based distributions).
+- Mesa GL headers (libgl1-mesa-dev on Debian 11 or Debian-based distributions).
+- (Optional) `scdoc` to generate man pages.
+
+Compiling
+BUilding and installing on the system
+```
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/usr" -DENABLE_LTO=ON
+cmake --build build -j$(nproc)
+sudo cmake --install build
+```
+Building a portable binary
+```
+cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install
+cmake --build build -j$(nproc)
+cmake --install build
+cmake --install build --component portable
+```
--
cgit
From 5083772c6f870cad6f55a30cad9c39aa905096d5 Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 15:37:11 +0200
Subject: Fixed markdown errors
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/BUILD.md b/BUILD.md
index 41dd80e3..bfe59f5c 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -23,20 +23,24 @@ This guide will mostly mention dependant packages by their Debian naming.
- `extra-cmake-modules`.
- zlib (`zlib1g-dev` on Debian 11 or Debian-based distributions).
- Java Development Kit (Java JDK) (`openjdk-17-jdk` on Debian 11 or Debian-based distributions).
-- Mesa GL headers (libgl1-mesa-dev on Debian 11 or Debian-based distributions).
+- Mesa GL headers (`libgl1-mesa-dev` on Debian 11 or Debian-based distributions).
- (Optional) `scdoc` to generate man pages.
Compiling
-BUilding and installing on the system
+Building and installing on the system
+
```
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/usr" -DENABLE_LTO=ON
cmake --build build -j$(nproc)
sudo cmake --install build
```
+
Building a portable binary
+
```
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install
cmake --build build -j$(nproc)
cmake --install build
cmake --install build --component portable
```
+
--
cgit
From 2ee5c6b2a18d12ef21417df2bd5fb83feff2ca10 Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 15:38:32 +0200
Subject: Totally skipped a typo
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/BUILD.md b/BUILD.md
index bfe59f5c..ba4ccd25 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -1,6 +1,6 @@
# Build Instructions
-Full build instructions will are available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
+Full build instructions will be available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
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/PlaceholderMC/website/blob/master/src/wiki/development/build-instructions.md).
--
cgit
From 421522a61ad74750b83fc2f57f9d70cdb53ae73e Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 15:52:00 +0200
Subject: Added further clarifications
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/BUILD.md b/BUILD.md
index ba4ccd25..b4a89fea 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -14,10 +14,10 @@ cd PrismLauncher
Linux
-This guide will mostly mention dependant packages by their Debian naming.
+This guide will mostly mention dependant packages by their Debian naming and commands are done by a user in the sudoers file.
Dependencies
-- A C++ compiler capable of building C++17 code.
+- 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`).
- `cmake` 3.15 or newer.
- `extra-cmake-modules`.
@@ -26,8 +26,15 @@ This guide will mostly mention dependant packages by their Debian naming.
- Mesa GL headers (`libgl1-mesa-dev` on Debian 11 or Debian-based distributions).
- (Optional) `scdoc` to generate man pages.
+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
+This is usually the suggested way to build the client.
```
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/usr" -DENABLE_LTO=ON
--
cgit
From 06d28c3eecb0c046e9680e5025e84c619c48db03 Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 15:57:43 +0200
Subject: Updated project naming
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/BUILD.md b/BUILD.md
index b4a89fea..8d70d1ed 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -2,13 +2,13 @@
Full build instructions will be available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
-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/PlaceholderMC/website/blob/master/src/wiki/development/build-instructions.md).
+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
Clone the source code using git, and grab all the submodules. This is generic for all platforms you want to build on.
```
-git clone --recursive https://github.com/PlaceholderMC/PrismLauncher
+git clone --recursive https://github.com/PrismLauncher/PrismLauncher
cd PrismLauncher
```
--
cgit
From 17a1e1245cfaf22abc36e0c1ece7043ea85c1604 Mon Sep 17 00:00:00 2001
From: Sergio <42090377+SSUPII@users.noreply.github.com>
Date: Tue, 18 Oct 2022 16:04:28 +0200
Subject: Updated HTML tags to Markdown
Signed-off-by: Sergio <42090377+SSUPII@users.noreply.github.com>
---
BUILD.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
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
--
cgit