[docs] clion, openbsd deps, readme
All checks were successful
eden-license / license-header (pull_request) Successful in 34s
All checks were successful
eden-license / license-header (pull_request) Successful in 34s
Signed-off-by: crueter <crueter@eden-emu.dev>
This commit is contained in:
parent
71caf97337
commit
f62469004a
5 changed files with 45 additions and 60 deletions
|
@ -57,13 +57,7 @@ If you would like to contribute, we are open to new developers and pull requests
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
* **Windows**: [Windows Building Guide](./docs/build/Windows.md)
|
See the [General Build Guide](docs/Build.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)
|
|
||||||
|
|
||||||
## Download
|
## Download
|
||||||
|
|
||||||
|
|
|
@ -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.
|
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:
|
Recommended generators:
|
||||||
|
|
||||||
- MSYS2: `MSYS Makefiles`
|
- MSYS2: `MSYS Makefiles`
|
||||||
- MSVC: Install **[ninja](https://ninja-build.org/)** and use `Ninja`, OR use `Visual Studio 17 2022`
|
- MSVC: Install **[ninja](https://ninja-build.org/)** and use `Ninja`, OR use `Visual Studio 17 2022`
|
||||||
- macOS: `Ninja` (preferred) or `Xcode`
|
- macOS: `Ninja` (preferred) or `Xcode`
|
||||||
|
@ -77,9 +78,44 @@ cmake -S . -B build -G "GENERATOR" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPI
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### CLion
|
### [CLion](https://www.jetbrains.com/clion/)
|
||||||
|
|
||||||
TODO
|
<details>
|
||||||
|
<summary>Click to Open</summary>
|
||||||
|
|
||||||
|
* Clone the Repository:
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899046-0d41d7d6-8e4d-4ed2-9587-b57088af5214.png" width="500">
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899061-b2ea274a-e88c-40ae-bf0b-4450b46e9fea.png" width="500">
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899076-0e5988c4-d431-4284-a5ff-9ecff973db76.png" width="500">
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Building & Setup
|
||||||
|
|
||||||
|
* Once Cloned, You will be taken to a prompt like the image below:
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899092-3fe4cec6-a540-44e3-9e1e-3de9c2fffc2f.png" width="500">
|
||||||
|
|
||||||
|
* 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`
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899164-6cee8482-3d59-428f-b1bc-e6dc793c9b20.png" width="500">
|
||||||
|
|
||||||
|
* 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
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899226-975048e9-bc6d-4ec1-bc2d-bd8a1e15ed04.png" height="500" >
|
||||||
|
|
||||||
|
* Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built.
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/42481638/216899275-d514ec6a-e563-470e-81e2-3e04f0429b68.png" width="500">
|
||||||
|
</details>
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
@ -103,7 +139,7 @@ Simply hit Ctrl+B, or the "hammer" icon in the bottom left. To run, hit the "pla
|
||||||
|
|
||||||
### Command Line
|
### 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
|
cmake --build build
|
||||||
|
@ -121,4 +157,4 @@ Some platforms have convenience scripts provided for building.
|
||||||
- **[Linux](scripts/Linux.md)**
|
- **[Linux](scripts/Linux.md)**
|
||||||
- **[Windows](scripts/Windows.md)**
|
- **[Windows](scripts/Windows.md)**
|
||||||
|
|
||||||
macOS scripts will come soon. Maybe.
|
macOS scripts will come soon.
|
|
@ -180,7 +180,7 @@ If using FreeBSD 12 or prior, use `devel/pkg-config` instead.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pkg_add -u
|
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
|
||||||
```
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
@ -194,7 +194,7 @@ Run the usual update + install of essential toolings: `sudo pkg update && sudo p
|
||||||
- **gcc**: `sudo pkg install developer/gcc-14`.
|
- **gcc**: `sudo pkg install developer/gcc-14`.
|
||||||
- **clang**: Version 20 is broken, use `sudo pkg install developer/clang-19`.
|
- **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`.
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
|
@ -53,6 +53,8 @@ The following options are desktop only:
|
||||||
- `ENABLE_QT_TRANSLATION` (OFF) Enable translations for the Qt frontend
|
- `ENABLE_QT_TRANSLATION` (OFF) Enable translations for the Qt frontend
|
||||||
- `ENABLE_QT_UPDATE_CHECKER` (OFF) Enable update checker 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
|
- `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_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_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)
|
- `YUZU_USE_QT_WEB_ENGINE` (OFF) Use QtWebEngine for web applet implementation (requires the huge QtWebEngine dependency; not recommended)
|
||||||
|
|
|
@ -27,50 +27,3 @@
|
||||||
* The resulting zip will be placed into `artifacts` in the source directory.
|
* 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:
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899046-0d41d7d6-8e4d-4ed2-9587-b57088af5214.png" width="500">
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899061-b2ea274a-e88c-40ae-bf0b-4450b46e9fea.png" width="500">
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899076-0e5988c4-d431-4284-a5ff-9ecff973db76.png" width="500">
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### c. Building & Setup
|
|
||||||
|
|
||||||
* Once Cloned, You will be taken to a prompt like the image below:
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899092-3fe4cec6-a540-44e3-9e1e-3de9c2fffc2f.png" width="500">
|
|
||||||
|
|
||||||
* 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`
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899164-6cee8482-3d59-428f-b1bc-e6dc793c9b20.png" width="500">
|
|
||||||
|
|
||||||
* 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
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899226-975048e9-bc6d-4ec1-bc2d-bd8a1e15ed04.png" height="500" >
|
|
||||||
|
|
||||||
* Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built.
|
|
||||||
|
|
||||||
<img src="https://user-images.githubusercontent.com/42481638/216899275-d514ec6a-e563-470e-81e2-3e04f0429b68.png" width="500">
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue