diff --git a/README.md b/README.md index 07711bd04..7c770b5a2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Yuzu +[Releases](https://git.zaroz.cloud/nintendo-back-up/yuzu/yuzu/-/releases) -## Build Status +# Building + +## Linux I'm not able to build Yuzu from the backed up source code because there's a link error with [mbedtls](https://git.zaroz.cloud/nintendo-back-up/yuzu/yuzu-mbedtls). @@ -18,4 +21,44 @@ collect2: error: ld returned 1 exit status ninja: build stopped: subcommand failed. ``` -[Releases](https://git.zaroz.cloud/nintendo-back-up/yuzu/yuzu/-/releases) \ No newline at end of file +### Step 1: Clone the project + +Clone the project recursively +```sh +$ git clone --recursive https://git.zaroz.cloud/nintendo-back-up/yuzu/yuzu +``` + +### Step 2: Configure SPIRV Shaders + +We need to make some changes because SPIRV Shaders throws an error otherwise. If someone knows how to fix it please reach out to me. + +```sh +$ rm -rf externals/sirit/externals +``` + +Then edit `externals/sirit/CMakeLists.txt` and enable "Use system SPIR-V Headers". +Like this: +``` +option(SIRIT_USE_SYSTEM_SPIRV_HEADERS "Use system SPIR-V headers" ON) +``` + +### Step 3: Build + +Create a directory named `build` and cd into it. + +```sh +$ mkdir build +$ cd build +``` + +Then configure the project + +```sh +$ cmake .. -GNinja -DYUZU_USE_BUNDLED_VCPKG=ON -DYUZU_TESTS=OFF +``` + +Once that is done you can build it with + +```sh +$ ninja +``` \ No newline at end of file