From f62469004a98c544737845dff7096e4fe5b08c7e Mon Sep 17 00:00:00 2001 From: crueter Date: Mon, 15 Sep 2025 22:29:41 -0400 Subject: [PATCH] [docs] clion, openbsd deps, readme Signed-off-by: crueter --- README.md | 8 +------ docs/Build.md | 44 ++++++++++++++++++++++++++++++++++---- docs/Deps.md | 4 ++-- docs/Options.md | 2 ++ docs/scripts/Windows.md | 47 ----------------------------------------- 5 files changed, 45 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index e1f0b50b37..959b903385 100644 --- a/README.md +++ b/README.md @@ -57,13 +57,7 @@ If you would like to contribute, we are open to new developers and pull requests ## Building -* **Windows**: [Windows Building Guide](./docs/build/Windows.md) -* **Linux**: [Linux Building Guide](./docs/build/Linux.md) -* **Android**: [Android Building Guide](./docs/build/Android.md) -* **Solaris**: [Solaris Building Guide](./docs/build/Solaris.md) -* **FreeBSD**: [FreeBSD Building Guide](./docs/build/FreeBSD.md) -* **macOS**: [macOS Building Guide](./docs/build/macOS.md) -* **OpenBSD**: [OpenBSD Building Guide](./docs/build/OpenBSD.md) +See the [General Build Guide](docs/Build.md) ## Download diff --git a/docs/Build.md b/docs/Build.md index 13aa142ac0..52a671ab1e 100644 --- a/docs/Build.md +++ b/docs/Build.md @@ -56,6 +56,7 @@ This is recommended for *BSD, Solaris, Linux, and MSYS2. MSVC is possible, but n Note that CMake must be in your PATH, and you must be in the cloned Eden directory. On Windows, you must also set up a Visual C++ development environment. This can be done by running `C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat` in the same terminal. Recommended generators: + - MSYS2: `MSYS Makefiles` - MSVC: Install **[ninja](https://ninja-build.org/)** and use `Ninja`, OR use `Visual Studio 17 2022` - macOS: `Ninja` (preferred) or `Xcode` @@ -77,9 +78,44 @@ cmake -S . -B build -G "GENERATOR" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPI -### CLion +### [CLion](https://www.jetbrains.com/clion/) -TODO +
+Click to Open + +* Clone the Repository: + + + + + +--- + +### Building & Setup + +* Once Cloned, You will be taken to a prompt like the image below: + + + +* Set the settings to the image below: +* Change `Build type: Release` +* Change `Name: Release` +* Change `Toolchain Visual Studio` +* Change `Generator: Let CMake decide` +* Change `Build directory: build` + + + +* Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient. +* Once this process has been completed (No loading bar bottom right), you can now build eden +* In the top right, click on the drop-down menu, select all configurations, then select eden + + + +* Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built. + + +
## Troubleshooting @@ -103,7 +139,7 @@ Simply hit Ctrl+B, or the "hammer" icon in the bottom left. To run, hit the "pla ### Command Line -If you are not on Windows, and are using the `UNIX Makefiles` generator, you must also add `-j$(nproc)` to this command. +If you are not on Windows and are using the `UNIX Makefiles` generator, you must also add `-j$(nproc)` to this command. ``` cmake --build build @@ -121,4 +157,4 @@ Some platforms have convenience scripts provided for building. - **[Linux](scripts/Linux.md)** - **[Windows](scripts/Windows.md)** -macOS scripts will come soon. Maybe. \ No newline at end of file +macOS scripts will come soon. \ No newline at end of file diff --git a/docs/Deps.md b/docs/Deps.md index 9cfe36b547..f9a083d368 100644 --- a/docs/Deps.md +++ b/docs/Deps.md @@ -180,7 +180,7 @@ If using FreeBSD 12 or prior, use `devel/pkg-config` instead. ```sh pkg_add -u -pkg_add cmake nasm git boost unzip--iconv autoconf-2.72p0 bash ffmpeg glslang gmake llvm-19.1.7p3 qt6 jq +pkg_add cmake nasm git boost unzip--iconv autoconf-2.72p0 bash ffmpeg glslang gmake llvm-19.1.7p3 qt6 jq fmt nlohmann-json enet boost vulkan-utility-libraries vulkan-headers spirv-headers spirv-tools catch2 sdl2 ``` @@ -194,7 +194,7 @@ Run the usual update + install of essential toolings: `sudo pkg update && sudo p - **gcc**: `sudo pkg install developer/gcc-14`. - **clang**: Version 20 is broken, use `sudo pkg install developer/clang-19`. -Then install the libraies: `sudo pkg install qt6 boost glslang libzip library/lz4 nlohmann-json openssl opus sdl2 zlib compress/zstd unzip pkg-config nasm autoconf mesa library/libdrm header-drm developer/fmt`. +Then install the libraries: `sudo pkg install qt6 boost glslang libzip library/lz4 nlohmann-json openssl opus sdl2 zlib compress/zstd unzip pkg-config nasm autoconf mesa library/libdrm header-drm developer/fmt`.
diff --git a/docs/Options.md b/docs/Options.md index 61f578df8b..d19aab63f6 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -53,6 +53,8 @@ The following options are desktop only: - `ENABLE_QT_TRANSLATION` (OFF) Enable translations for the Qt frontend - `ENABLE_QT_UPDATE_CHECKER` (OFF) Enable update checker for the Qt frontend - `YUZU_USE_BUNDLED_QT` (ON for MSVC) Download bundled Qt binaries + * Note that using **system Qt** requires you to include the Qt CMake directory in `CMAKE_PREFIX_PATH`, e.g: + * `-DCMAKE_PREFIX_PATH=C:/Qt/6.9.0/msvc2022_64/lib/cmake/Qt6` - `YUZU_QT_MIRROR` (string) What mirror to use for downloading the bundled Qt libraries - `YUZU_USE_QT_MULTIMEDIA` (OFF) Use QtMultimedia for camera support - `YUZU_USE_QT_WEB_ENGINE` (OFF) Use QtWebEngine for web applet implementation (requires the huge QtWebEngine dependency; not recommended) diff --git a/docs/scripts/Windows.md b/docs/scripts/Windows.md index c1ebb5a4c2..e60c2119a2 100644 --- a/docs/scripts/Windows.md +++ b/docs/scripts/Windows.md @@ -27,50 +27,3 @@ * The resulting zip will be placed into `artifacts` in the source directory. -## 🖥️ Method III: CLion Environment Setup - -### a. Prerequisites to CLion - -* [CLion](https://www.jetbrains.com/clion/) - This IDE is not free; for a free alternative, check Method I - ---- - -### b. Cloning eden with CLion - -* Clone the Repository: - - - - - ---- - -### c. Building & Setup - -* Once Cloned, You will be taken to a prompt like the image below: - - - -* Set the settings to the image below: -* Change `Build type: Release` -* Change `Name: Release` -* Change `Toolchain Visual Studio` -* Change `Generator: Let CMake decide` -* Change `Build directory: build` - - - -* Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient. -* Once this process has been completed (No loading bar bottom right), you can now build eden -* In the top right, click on the drop-down menu, select all configurations, then select eden - - - -* Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built. - - - ---- - - -