diff --git a/dist/dev.eden_emu.eden.metainfo.xml b/dist/dev.eden_emu.eden.metainfo.xml index d0b4e259fb..ce5cc9a905 100644 --- a/dist/dev.eden_emu.eden.metainfo.xml +++ b/dist/dev.eden_emu.eden.metainfo.xml @@ -28,9 +28,9 @@ SPDX-License-Identifier: CC0-1.0 https://eden-emu.dev/ https://git.eden-emu.dev/eden-emu/eden/issues - https://eden-emu.dev/docs - https://eden-emu.dev/docs - https://eden-emu.dev/donations + https://eden-emu.dev/about + https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/user/README.md + https://liberapay.com/crueter https://explore.transifex.com/edenemu/eden-emulator https://discord.gg/HstXbPch7X https://git.eden-emu.dev diff --git a/docs/Build.md b/docs/Build.md index 986f0590a4..84a3784fc0 100644 --- a/docs/Build.md +++ b/docs/Build.md @@ -5,12 +5,15 @@ This is a full-fledged guide to build Eden on all supported platforms. -TL;DR +If you already have a development environment set up: + ```sh -cmake -DCMAKE_BUILD_TYPE=Release -Bbuild -GNinja -cmake --build build -t yuzu --parallel +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -G Ninja +cmake --build build ``` +On Linux, macOS, and MinGW/MSYS2, make sure to read the [dependencies guide](Deps.md). On Android, read its [dedicated page](build/Android.md). + ## Dependencies First, you must [install some dependencies](Deps.md). diff --git a/docs/Deps.md b/docs/Deps.md index 455f875c7b..90108577a4 100644 --- a/docs/Deps.md +++ b/docs/Deps.md @@ -262,7 +262,7 @@ brew install molten-vk As root run: ```sh -pkg install devel/cmake devel/sdl3 devel/boost-libs devel/catch2 devel/libfmt devel/nlohmann-json devel/ninja devel/nasm devel/autoconf devel/pkgconf devel/qt6-base x11-toolkits/qt6-charts devel/simpleini net/enet multimedia/ffnvcodec-headers multimedia/ffmpeg audio/opus archivers/liblz4 lang/gcc12 graphics/glslang graphics/vulkan-utility-libraries graphics/spirv-tools www/cpp-httplib devel/unordered-dense vulkan-headers quazip-qt6 +pkg install devel/cmake devel/sdl3 devel/boost-libs devel/catch2 devel/libfmt devel/nlohmann-json devel/ninja devel/nasm devel/autoconf devel/pkgconf devel/qt6-base x11-toolkits/qt6-charts devel/simpleini net/enet multimedia/ffnvcodec-headers multimedia/ffmpeg audio/opus archivers/liblz4 lang/gcc12 graphics/glslang graphics/vulkan-utility-libraries graphics/spirv-tools www/cpp-httplib devel/unordered-dense graphics/vulkan-utility-libraries graphics/vulkan-headers graphics/spirv-headers quazip-qt6 ``` If using FreeBSD 12 or prior, use `devel/pkg-config` instead. diff --git a/docs/user/Architectures.md b/docs/user/Architectures.md index 720ce8ff6f..d5f9acd74c 100644 --- a/docs/user/Architectures.md +++ b/docs/user/Architectures.md @@ -69,29 +69,15 @@ Wayland is not recommended. Testing has shown significantly worse performance on ## Windows -Windows 10 and 11 are supported. Support for Windows 8.x is unknown, and Windows 7 support is unlikely to ever be added. +Windows 10 and 11 are supported. Anything below is unsupported. -In order to run Eden, you will probably need to install the [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170). +To run Eden, you'll need to install [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170). Neither AMD/NVIDIA drivers work nearly as well as Linux's RADV drivers. Compatibility is still largely the same, but performance and some hard-to-run games may suffer compared to Linux. -Tacit support for down to XP is provided for interested hobbyists. Read below. - -### Windows 7, 8, 8.1 - -DirectX 12 is not available - simply copy and paste any DLL and name it `d3d12.dll`. - -Install [Qt6 compatibility libraries](https://github.com/crystalidea/qt6windows7) specifically Qt 6.9.5. - -### Windows XP, Vista - -If you haven't already, install appropriate updates using [Legacy Update](https://legacyupdate.net/). We highly recommend to install [One-Core-API](https://github.com/shorthorn-project/One-Core-API-Binaries) as well. - -64-bit support is *mandatory*, there are no plans to add 32-bit support (PRs are welcome of course). While AVX2 support is recommended, it isn't a hard requirement. SSE4.1+ is recommended however, while the emulator does run well without (minimum is SSE3), non-SSE4.1 code paths are unmaintained. - ### Windows on ARM -If you're using Snapdragon X or 8CX, use the [the Vulkan translation layer](https://apps.microsoft.com/detail/9nqpsl29bfff?hl=en-us&gl=USE) only if the stock drivers do not work. And of course always keep your system up-to-date. +If you're using Snapdragon X or 8CX, install the [Vulkan translation layer](https://apps.microsoft.com/detail/9nqpsl29bfff?hl=en-us&gl=USE) only if the stock drivers don't work. And of course always keep your system up-to-date. ## Android diff --git a/docs/user/CFW.md b/docs/user/CFW.md index 2918e80647..e9213e5dac 100644 --- a/docs/user/CFW.md +++ b/docs/user/CFW.md @@ -12,7 +12,7 @@ If they don't run - then that's a bug! ## Atmosphere -Fusee-Galee, the bootloader and other low-level mechanisms are not emulated at the moment. +Fusée Gelée, the bootloader and other low-level mechanisms are not emulated at the moment. Having OFW is recommended, but may not be required (untested). diff --git a/tools/README.md b/tools/README.md index 1ce32f28c1..cde6a21464 100644 --- a/tools/README.md +++ b/tools/README.md @@ -32,6 +32,7 @@ Tools for Eden and other subprojects. When adding new scripts please use `#!/bin - `fuzzsettings.cpp`: Fuzz settings files. ## Android + It's recommended to run these scripts after almost any Android change, as they are relatively fast and important both for APK bloat and CI. - `unused-strings.sh`: Finds unused strings in `strings.xml` files.