mirror of
https://github.com/RPCS3/rpcs3.git
synced 2024-12-28 00:18:23 +00:00
b3513cd7fa
And update the documentation accordingly
40 lines
2.1 KiB
Markdown
40 lines
2.1 KiB
Markdown
RPCS3
|
|
=====
|
|
|
|
[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)
|
|
[![Build status](https://ci.appveyor.com/api/projects/status/411c4clmiohtx7eo/branch/master?svg=true)](https://ci.appveyor.com/project/rpcs3/rpcs3/branch/master)
|
|
|
|
The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows and Linux.
|
|
|
|
You can find some basic information on our [**website**](https://rpcs3.net/). Game info is being populated on the [**Wiki**](https://wiki.rpcs3.net/).
|
|
For discussion about this emulator, PS3 emulation, and game compatibility reports, please visit our [**forums**](https://forums.rpcs3.net) and our [**Discord server**](https://discord.me/RPCS3).
|
|
|
|
[**Support Lead Developers Nekotekina and kd-11 on Patreon**](https://www.patreon.com/Nekotekina)
|
|
|
|
## Contributing
|
|
|
|
If you want to help the project but do not code, the best way to help out is to test games and make bug reports. See:
|
|
* [Quickstart](https://rpcs3.net/quickstart)
|
|
|
|
If you want to contribute as a developer, please take a look at the following pages:
|
|
|
|
* [Coding Style](https://github.com/RPCS3/rpcs3/wiki/Coding-Style)
|
|
* [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information)
|
|
* [Roadmap](https://rpcs3.net/roadmap)
|
|
|
|
You should also contact any of the developers in the forums or in the Discord server to learn more about the current state of the emulator.
|
|
|
|
## Building
|
|
|
|
See [BUILDING.md](BUILDING.md) for more information about how to setup an environment to build RPCS3.
|
|
|
|
## Running
|
|
|
|
Check our friendly [quickstart](https://rpcs3.net/quickstart) guide to make sure your computer meets the minimum system requirements to run RPCS3.
|
|
|
|
Don't forget to have your graphics driver up to date and to install the [Visual C++ Redistributable Packages for Visual Studio 2017](https://go.microsoft.com/fwlink/?LinkId=746572) if you are a Windows user.
|
|
|
|
## License
|
|
|
|
Most files are licensed under the terms of GNU GPLv2 License; see LICENSE file for details. Some files may be licensed differently; check appropriate file headers for details.
|