rpcs3/README.md

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.
Fixed error in SC_Pad.cpp and Readme.md updated 2014-04-07 14:40:50 +02:00			`RPCS3`
Initial commit 2012-11-03 16:16:18 +01:00			`=====`

Modify .travis.yml to enable Travis. Fix the master git repo name in Github, also the one in git-version-gen.cmd. Display Shell Export List to help debugging our Travis Build. 2015-04-08 20:02:54 +02:00			`[![Build Status](https://travis-ci.org/RPCS3/rpcs3.svg?branch=master)](https://travis-ci.org/RPCS3/rpcs3)`
Add appveyor badge 2015-08-04 17:52:16 +02:00			`[![Build status](https://ci.appveyor.com/api/projects/status/411c4clmiohtx7eo/branch/master?svg=true)](https://ci.appveyor.com/project/rpcs3/rpcs3/branch/master)`
Add Coveralls badge Start making unit tests now! 2015-01-26 19:53:00 +01:00
README update Specified "free and open-source" instead of just "open-source". 2018-10-10 03:25:41 +02:00			`The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows and Linux.`
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 03:24:48 +02: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/).`
			`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).`
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 01:17:43 +02: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 12:57:23 +01:00
Rewrite readme 2018-12-20 01:52:18 +01:00			`## Contributing`
Add Linux build instructions for Debian & Ubuntu 2014-04-13 03:19:48 +02:00
Rewrite readme 2018-12-20 01:52:18 +01: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-13 03:19:48 +02:00
Rewrite readme 2018-12-20 01:52:18 +01: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 15:57:09 +01: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 15:57:09 +01:00
Set minimum supported version of GCC to 8.x And update the documentation accordingly 2019-06-10 21:52:07 +02:00			`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.`
Add an easy way for package builders to disable native cpu optimizations 2018-02-19 04:55:46 +01:00
Update Readme (#2829) 2017-06-04 17:44:48 +02:00			`## License`
Add "License" section 2016-12-02 11:40:41 +01:00
README update Minor cleanup such as capitalization fixes, wording changes, and punctuation tweaks. 2018-10-10 03:24:48 +02:00			`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.`