rpcs3/README.md

RPCS3
=====

[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/RPCS3/rpcs3?label=Cirrus%20CI&logo=cirrus-ci)](https://cirrus-ci.com/github/RPCS3/rpcs3)
[![RPCS3 Discord Server](https://img.shields.io/discord/272035812277878785?color=5865F2&label=RPCS3%20Discord&logo=discord&logoColor=white)](https://discord.me/rpcs3)

The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows, Linux, macOS and FreeBSD.

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.gg/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 2019](https://aka.ms/vs/16/release/VC_redist.x64.exe) if you are a Windows user.

## License

Most files are licensed under the terms of GNU GPL-2.0-only License; see LICENSE file for details. Some files may be licensed differently; check appropriate file headers for details.
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`RPCS3`
Initial commit 2012-11-03 08:16:18 -07:00			`=====`

readme: Remove Azure, rename Cirrus CI badges 2023-01-28 12:31:51 +00:00			`[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/RPCS3/rpcs3?label=Cirrus%20CI&logo=cirrus-ci)](https://cirrus-ci.com/github/RPCS3/rpcs3)`
			`[![RPCS3 Discord Server](https://img.shields.io/discord/272035812277878785?color=5865F2&label=RPCS3%20Discord&logo=discord&logoColor=white)](https://discord.me/rpcs3)`
Add Coveralls badge Start making unit tests now! 2015-01-26 20:53:00 +02:00
readme: improvements Fixed platform availability Fixed discord link (discord.me is not valid) 2022-09-11 20:18:48 +10:00			`The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows, Linux, macOS and FreeBSD.`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
README update Minor cleanup such as capitalization fixes, wording changes, and punctuation tweaks. 2018-10-10 01:24:48 +00:00			`You can find some basic information on our [website](https://rpcs3.net/). Game info is being populated on the [Wiki](https://wiki.rpcs3.net/).`
readme: improvements Fixed platform availability Fixed discord link (discord.me is not valid) 2022-09-11 20:18:48 +10:00			`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.gg/RPCS3).`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
Point forums URLs to the new one Updates forums URLs to our new forums 2017-08-23 00:17:43 +01:00			`[Support Lead Developers Nekotekina and kd-11 on Patreon](https://www.patreon.com/Nekotekina)`
Update README.md (#2267) Added discord server address Added patreon link 2017-01-21 14:57:23 +03:00
Rewrite readme 2018-12-19 16:52:18 -08:00			`## Contributing`
Add Linux build instructions for Debian & Ubuntu 2014-04-12 19:19:48 -06:00
Rewrite readme 2018-12-19 16:52:18 -08:00			`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.`
Add Linux build instructions for Debian & Ubuntu 2014-04-12 19:19:48 -06:00
Rewrite readme 2018-12-19 16:52:18 -08:00			`## Building`
Update Readme with some links to the wiki and forums 2014-02-09 18:41:20 +01:00
Set minimum supported version of GCC to 8.x And update the documentation accordingly 2019-06-10 21:52:07 +02:00			`See [BUILDING.md](BUILDING.md) for more information about how to setup an environment to build RPCS3.`
Linux build fix + instructions 2017-01-22 17:57:09 +03:00
Set minimum supported version of GCC to 8.x And update the documentation accordingly 2019-06-10 21:52:07 +02:00			`## Running`
Update build instructions for macOS 2017-08-08 18:20:41 +02:00
Set minimum supported version of GCC to 8.x And update the documentation accordingly 2019-06-10 21:52:07 +02:00			`Check our friendly [quickstart](https://rpcs3.net/quickstart) guide to make sure your computer meets the minimum system requirements to run RPCS3.`
Linux build fix + instructions 2017-01-22 17:57:09 +03:00
[README.md] Update to Visual C++ Redistributable 2019 2020-03-23 19:37:16 +11:00			`Don't forget to have your graphics driver up to date and to install the [Visual C++ Redistributable Packages for Visual Studio 2019](https://aka.ms/vs/16/release/VC_redist.x64.exe) if you are a Windows user.`
Add an easy way for package builders to disable native cpu optimizations 2018-02-18 19:55:46 -08:00
Update Readme (#2829) 2017-06-04 16:44:48 +01:00			`## License`
Add "License" section 2016-12-02 13:40:41 +03:00
Make RPCS3 license explicit in README 2021-05-16 16:12:42 +05:30			`Most files are licensed under the terms of GNU GPL-2.0-only License; see LICENSE file for details. Some files may be licensed differently; check appropriate file headers for details.`