rpcsx/.github/readme.md
illusion0001 bfcc50d000
Add Build CI (#14)
* Add Build CI

Co-Authored-By: Margen67 <Margen67@users.noreply.github.com>

* Readme: Change badges

---------

Co-authored-by: Margen67 <Margen67@users.noreply.github.com>
2023-07-08 21:05:33 +03:00

39 lines
1.3 KiB
Markdown

<div align="center">
# RPCSX
*An experimental emulator for PS4 (PlayStation 4) for Linux written in C++*
[![Build RPCSX](../../../actions/workflows/rpcsx.yml/badge.svg)](../../../actions/workflows/rpcsx.yml)
[![Formatting check](../../../actions/workflows/format.yml/badge.svg)](../../../actions/workflows/format.yml)
[![](https://img.shields.io/discord/252023769500090368?color=5865F2&logo=discord&logoColor=white)](https://discord.gg/t6dzA4wUdG)
</div>
> **Warning** <br/>
> It's NOT possible to run any games yet, and there is no ETA for when this will change
## Contributing
If you want to contribute as a developer, please contact us in the [Discord](https://discord.gg/t6dzA4wUdG).
## Building
1. Install dependencies for Debian-like distributions
`sudo apt install build-essential cmake libunwind-dev libglfw3-dev libvulkan-dev vulkan-validationlayers-dev spirv-tools glslang-tools`
2. Building
`mkdir -p build && cd build && cmake .. && cmake --build .`
4. Run
See usage message of `rpcsx-os` (`-h` argument), or join the [Discord](https://discord.gg/t6dzA4wUdG) for help.
## License
RPCSX is licensed under GPLv2 license except directories containing their own LICENSE file, or files containing their own license.
Thus, orbis-kernel is licensed under the MIT license.