diff options
Diffstat (limited to 'docs/build/FreeBSD.md')
| -rw-r--r-- | docs/build/FreeBSD.md | 164 |
1 files changed, 80 insertions, 84 deletions
diff --git a/docs/build/FreeBSD.md b/docs/build/FreeBSD.md index 475378125c..97eef8f9d8 100644 --- a/docs/build/FreeBSD.md +++ b/docs/build/FreeBSD.md @@ -1,85 +1,81 @@ -## One word of caution before proceeding.
-
-This is not the usual or preferred way to build programs on FreeBSD.
-As of writing there is no official fresh port available for Eden, but it is in the works.
-After it is available you can find a link to the eden-emu fresh port here and on Escary's github repo.
-See this build as an AppImage alternative for FreeBSD.
-
-## Dependencies.
-Before we start we need some dependencies.
-These dependencies are generally needed to build Eden on FreeBSD.
-
-```
-devel/cmake
-devel/sdl20
-devel/boost-libs
-devel/catch2
-devel/libfmt
-devel/nlohmann-json
-devel/ninja
-devel/nasm
-devel/autoconf
-devel/pkgconf
-devel/qt6-base
-
-multimedia/ffnvcodec-headers
-multimedia/ffmpeg
-
-audio/opus
-
-archivers/liblz4
-
-lang/gcc12
-
-graphics/glslang
-graphics/vulkan-utility-libraries
-```
-
-If using FreeBSD 12 or prior, use `devel/pkg-config` instead.
-
----
-
-### Build preparations:
-Run the following command to clone eden with git:
-```sh
-git clone --recursive https://git.eden-emu.dev/eden-emu/eden
-```
-You usually want to add the `--recursive` parameter as it also takes care of the external dependencies for you.
-
-Now change into the eden directory and create a build directory there:
-```sh
-cd eden
-mkdir build
-```
-
-Change into that build directory:
-```sh
-cd build
-```
-
-#### 1. Building in Release Mode (usually preferred and the most performant choice):
-```sh
-cmake .. -GNinja -DYUZU_TESTS=OFF
-```
-
-#### 2. Building in Release Mode with debugging symbols (useful if you want to debug errors for a eventual fix):
-```sh
-cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DYUZU_TESTS=ON
-```
-
-Build the emulator locally:
-```sh
-ninja
-```
-
-Optional: If you wish to install eden globally onto your system issue the following command:
-```sh
-sudo ninja install
-```
-OR
-```sh
-doas -- ninja install
-```
-
-## OpenSSL
+Eden is not currently available as a port on FreeBSD, though it is in the works. For now, the recommended method of usage is to compile it yourself. Check back often, as the build process frequently changes. + +## Dependencies. +Eden needs the following dependencies: + +``` +devel/cmake +devel/sdl20 +devel/boost-libs +devel/catch2 +devel/libfmt +devel/nlohmann-json +devel/ninja +devel/nasm +devel/autoconf +devel/pkgconf +devel/qt6-base + +net/enet + +multimedia/ffnvcodec-headers +multimedia/ffmpeg + +audio/opus + +archivers/liblz4 + +lang/gcc12 + +graphics/glslang +graphics/vulkan-utility-libraries +``` + +If using FreeBSD 12 or prior, use `devel/pkg-config` instead. + +--- + +### Build preparations: +Run the following command to clone eden with git: +```sh +git clone --recursive https://git.eden-emu.dev/eden-emu/eden +``` +You usually want to add the `--recursive` parameter as it also takes care of the external dependencies for you. + +Now change into the eden directory and create a build directory there: +```sh +cd eden +mkdir build +``` + +Change into that build directory: +```sh +cd build +``` + +#### 1. Building in Release Mode (usually preferred and the most performant choice): +```sh +cmake .. -GNinja -DYUZU_TESTS=OFF +``` + +#### 2. Building in Release Mode with debugging symbols (useful if you want to debug errors for a eventual fix): +```sh +cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DYUZU_TESTS=ON +``` + +Build the emulator locally: +```sh +ninja +``` + +Optional: If you wish to install eden globally onto your system issue the following command: +```sh +sudo ninja install +``` +OR +```sh +doas -- ninja install +``` + +## OpenSSL The available OpenSSL port (3.0.17) is out-of-date, and using a bundled static library instead is recommended; to do so, add `-DYUZU_USE_CPM=ON` to your CMake configure command.
\ No newline at end of file |
