From b26773a9d000616c724fbfbe961b63133f5e3925 Mon Sep 17 00:00:00 2001
From: RyzenDew <84041391+RyzenDew@users.noreply.github.com>
Date: Fri, 21 Jul 2023 02:58:26 -0300
Subject: [PATCH] Move Building instruction's to a BUILDING.md and add new deps
for fedora and arch (#23)
---
.github/BUILDING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++
.github/readme.md | 46 ++----------------------
2 files changed, 90 insertions(+), 44 deletions(-)
create mode 100644 .github/BUILDING.md
diff --git a/.github/BUILDING.md b/.github/BUILDING.md
new file mode 100644
index 000000000..bac64eea7
--- /dev/null
+++ b/.github/BUILDING.md
@@ -0,0 +1,88 @@
+## Building
+
+
+### The dependencies for Debian-like distributions.
+
+```
+sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev vulkan-validationlayers-dev spirv-tools glslang-tools libspirv-cross-c-shared-dev
+```
+
+### The dependencies for Fedora distributions:
+
+```
+sudo dnf install cmake libunwind-devel glfw-devel vulkan-devel vulkan-validation-layers-devel spirv-tools glslang-devel gcc-c++ gcc spirv-tools-devel xbyak-devel
+```
+
+### The dependencies for Arch distributions:
+
+```
+sudo pacman -S libunwind glfw-x11 vulkan-devel glslang
+```
+> Side note you will need to pull ``spirv-cross`` from the AUR for now so do the following
+```
+sudo pacman -S --needed git base-devel && git clone https://aur.archlinux.org/yay.git && cd yay && makepkg -si
+```
+```
+yay -S spirv-cross
+```
+
+## Getting spriv-cross on Fedora and Arch Linux
+
+```
+git clone https://github.com/KhronosGroup/SPIRV-Cross && cd SPIRV-Cross && mkdir build && cd build && cmake .. && cmake --build . && sudo make install
+```
+> **Warning**
+> Fedora will compile to a point and then error out
+> Arch will have to use xbyak from the aur for now
+
+## Cloning the Repo
+
+```
+git clone --recursive https://github.com/RPCSX/rpcsx && cd rpcsx
+```
+```
+git submodule update --init --recursive
+```
+## How to compile the emulator
+
+```
+mkdir -p build && cd build && cmake .. && cmake --build .
+```
+
+## How to create a Virtual HDD
+
+> The PS4 has a case-insensitive filesystem. To create the Virtual HDD, do the following:
+
+```
+truncate -s 512M ps4-hdd.exfat
+
+mkfs.exfat -n PS4-HDD ./ps4-hdd.exfat
+
+mkdir ps4-fs
+
+sudo mount -t exfat -o uid=`id -u`,gid=`id -g` ./ps4-hdd.exfat ./ps4-fs
+```
+
+## How to run samples and games
+
+See the Commands of `rpcsx-os` (`-h` argument), or join the [Discord](https://discord.gg/t6dzA4wUdG) for help.
+
+You can run the emulator with some samples using this command:
+
+```
+rm -f /dev/shm/rpcsx-* && ./rpcsx-os --mount "/system" "/system" --mount "" /app0 /app0/some-test-sample.elf [...]
+```
+
+## Creating a log
+
+You can use this flag if you encountered a segfault for debugging purposes.
+
+```
+--trace
+```
+
+You can redirect all log messages to a file by appending this command:
+
+```
+&>log.txt
+```
diff --git a/.github/readme.md b/.github/readme.md
index ad7815178..21919d13b 100644
--- a/.github/readme.md
+++ b/.github/readme.md
@@ -21,51 +21,9 @@
If you want to contribute as a developer, please contact us in the [Discord](https://discord.gg/t6dzA4wUdG).
-## Building
-
-First, install the dependencies for Debian-like distributions.
-
-``sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev vulkan-validationlayers-dev spirv-tools glslang-tools libspirv-cross-c-shared-dev libxbyak-dev``
-
-## Cloning the Repo
-
-``git clone https://github.com/RPCSX/rpcsx && cd rpcsx``
-
-## Building the emulator
-
-`mkdir -p build && cd build && cmake .. && cmake --build .`
-
-## How to create a Virtual HDD
-
-> The PS4 has a case-insensitive filesystem. To create the Virtual HDD, do the following:
-
-`truncate -s 512M ps4-hdd.exfat`
-
-`mkfs.exfat -n PS4-HDD ./ps4-hdd.exfat`
-
-`mkdir ps4-fs`
-
-``sudo mount -t exfat -o uid=`id -u`,gid=`id -g` ./ps4-hdd.exfat ./ps4-fs``
-
-## How to run samples and games
-
-See usage message of `rpcsx-os` (`-h` argument), or join the [Discord](https://discord.gg/t6dzA4wUdG) for help.
-
-You can run the emulator with some samples using this command:
-
-`rm -f /dev/shm/rpcsx-* && ./rpcsx-os --mount "/system" "/system" --mount "" /app0 /app0/some-test-sample.elf [...]`
-
-## Creating a log
-
-You can use this flag if you encountered a segfault for debugging purposes.
-
-`--trace`
-
-You can redirect all log messages to a file by appending this command:
-
-`&>log.txt`
-
+## How to Compile the Emulator
+* [How to Compile rpcsx](BUILDING.md)
## License