Separate Usage doc from building (#27)

* Separate Usage doc from building

* Cleanup usage doc
This commit is contained in:
Ayoub NASR 2023-07-25 21:32:26 +02:00 committed by GitHub
parent 2a505e81de
commit 483e5d9831
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 26 additions and 24 deletions

25
.github/USAGE.md vendored Normal file
View file

@ -0,0 +1,25 @@
# Usage
## 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:
```sh
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 encountered a segfault for debugging purposes.
```sh
--trace
```
You can redirect all log messages to a file by appending this command:
```sh
&>log.txt
```