chore: format markdown files
Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>
This commit is contained in:
parent
95a0bd61a9
commit
a1130dace0
52
BUILD.md
52
BUILD.md
@ -1,53 +1,3 @@
|
||||
# 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/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/PrismLauncher/PrismLauncher
|
||||
cd PrismLauncher
|
||||
```
|
||||
|
||||
## Linux
|
||||
|
||||
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 (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`.
|
||||
- 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.
|
||||
|
||||
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
|
||||
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
|
||||
```
|
||||
|
||||
Full build instructions are available on [the website](https://prismlauncher.org/wiki/development/build-instructions/).
|
||||
|
@ -8,10 +8,10 @@
|
||||
> Redistribution and use in source and binary forms, with or without
|
||||
> modification, are permitted provided that the following conditions are met:
|
||||
>
|
||||
> * Redistributions of source code must retain the above copyright notice, this
|
||||
> * Redistributions of source code must retain the above copyright notice, this
|
||||
> list of conditions and the following disclaimer.
|
||||
>
|
||||
> * Redistributions in binary form must reproduce the above copyright notice,
|
||||
> * Redistributions in binary form must reproduce the above copyright notice,
|
||||
> this list of conditions and the following disclaimer in the documentation
|
||||
> and/or other materials provided with the distribution.
|
||||
>
|
||||
@ -36,12 +36,12 @@ Cryptographic methods for Qt.
|
||||
> Redistribution and use in source and binary forms, with or without
|
||||
> modification, are permitted provided that the following conditions are met:
|
||||
>
|
||||
> * Redistributions of source code must retain the above copyright
|
||||
> * Redistributions of source code must retain the above copyright
|
||||
> notice, this list of conditions and the following disclaimer.
|
||||
> * Redistributions in binary form must reproduce the above copyright
|
||||
> * Redistributions in binary form must reproduce the above copyright
|
||||
> notice, this list of conditions and the following disclaimer in the
|
||||
> documentation and/or other materials provided with the distribution.
|
||||
> * Neither the name of the Rathenau Instituut, Andre Somers nor the
|
||||
> * Neither the name of the Rathenau Instituut, Andre Somers nor the
|
||||
> names of its contributors may be used to endorse or promote products
|
||||
> derived from this software without specific prior written permission.
|
||||
>
|
||||
@ -62,7 +62,7 @@ Configurable settings storage, Twitter XAuth specialization, new demos, cleanups
|
||||
|
||||
> "Hi Akos,
|
||||
>
|
||||
> I'm writing this mail to confirm that my contributions to the O2 library, available here https://github.com/pipacs/o2, can be freely distributed according to the project's license (as shown in the LICENSE file).
|
||||
> I'm writing this mail to confirm that my contributions to the O2 library, available here <https://github.com/pipacs/o2>, can be freely distributed according to the project's license (as shown in the LICENSE file).
|
||||
>
|
||||
> Regards,
|
||||
> -mandeep"
|
||||
|
Loading…
Reference in New Issue
Block a user