nucleus/README.md
2016-05-13 16:55:39 +02:00

25 lines
1.5 KiB
Markdown

Nucleus
=======
[![Last Release](https://img.shields.io/badge/version-0.1.0-brightgreen.svg?style=flat)](https://github.com/AlexAltea/nucleus/releases)
Created by Alexandro Sánchez Bach.
High-performance retargetable emulator for Windows / Linux / OS X / Android / iOS under GPLv2 license.
### Targets
* PlayStation 3
### Requirements
You need to provide the PlayStation 3 firmware keys by placing a file named `keys.xml` next to the Nucleus executable. This file has to meet the requirements stated [here](docs/user/keys.md). Instructions about how to extract the keys and generate the file will be provided as well.
### Contact
Official IRC channel available here: [`#nucleus-emu`](http://webchat.freenode.net/?channels=%23nucleus-emu) at `irc.freenode.org:6667`.
This channel is dedicated **exclusively to development-related topics**. Once this project reaches a state where general discussion and end-user support is convenient, corresponding parallel channels will be created. Anyone asking about or sharing information related to illegal activities will be banned from the channel.
### Pages
* [__Building__](docs/development/building.md): Information about compiling this project.
### Disclaimer
The goal of this project is to experiment, research, and educate on the topic of emulation of modern devices and operating systems. **It is not for enabling illegal activity**. All information is obtained via reverse engineering of legally purchased devices and games and information made public on the Internet.