Readme.md amendments

This commit is contained in:
GamingDuck 2023-07-20 08:41:57 +03:00 committed by GitHub
parent fd16ce4f62
commit 72185f0086
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

16
.github/readme.md vendored
View file

@ -23,7 +23,7 @@ If you want to contribute as a developer, please contact us in the [Discord](htt
## Building
First Install The dependencies for Debian-like distributions.
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``
@ -31,13 +31,13 @@ First Install The dependencies for Debian-like distributions.
``git clone https://github.com/RPCSX/rpcsx && cd rpcsx``
## Command for building the emulator.
## Building the emulator
`mkdir -p build && cd build && cmake .. && cmake --build .`
## How to create virtual hdd
## How to create a Virtual HDD
> The PS4 has case-insensitive filesystem. To create the virtual hdd do the following:
> The PS4 has a case-insensitive filesystem. To create the Virtual HDD, do the following:
`truncate -s 512M ps4-hdd.exfat`
@ -47,21 +47,21 @@ First Install The dependencies for Debian-like distributions.
``sudo mount -t exfat -o uid=`id -u`,gid=`id -g` ./ps4-hdd.exfat ./ps4-fs``
## How to Run samples and games ( one day )
## 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 emulator with Samples using this command:
You can run the emulator with some samples using this command:
`rm -f /dev/shm/rpcsx-* && ./rpcsx-os --mount "<path to fw>/system" "/system" --mount "<path to 'game' root>" /app0 /app0/some-test-sample.elf [<args for test elf>...]`
## Creating a log
You can use this flag if you get sigfault for debugging.
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 following to command:
You can redirect all log messages to a file by appending this command:
`&>log.txt`