Readme cleanup & redesign

Also added link to Netplay repo until it will be merge to Canary
This commit is contained in:
Radosław Gliński 2024-01-19 22:19:17 +01:00 committed by GitHub
parent 735e5beb01
commit be689457cb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 23 deletions

View File

@ -1,17 +1,14 @@
<p align="center"> <p align="center">
<a href="https://github.com/xenia-project/xenia/tree/master/assets/icon"> <a href="https://github.com/xenia-canary/xenia-canary/tree/canary_experimental/assets/icon">
<img height="120px" src="https://raw.githubusercontent.com/xenia-project/xenia/master/assets/icon/128.png" /> <img height="120px" src="https://raw.githubusercontent.com/xenia-canary/xenia/master/assets/icon/128.png" />
</a> </a>
</p> </p>
<h1 align="center">Xenia - Xbox 360 Emulator</h1> <h1 align="center">Xenia Canary - Xbox 360 Emulator</h1>
Xenia is an experimental emulator for the Xbox 360. For more information, see the Xenia is an experimental emulator for the Xbox 360. For more information, see the
[main Xenia wiki](https://github.com/xenia-project/xenia/wiki). [main Xenia wiki](https://github.com/xenia-project/xenia/wiki).
**Interested in supporting the core contributors?** Visit
[Xenia Project on Patreon](https://www.patreon.com/xenia_project).
Come chat with us about **emulator-related topics** on [Discord](https://discord.gg/Q9mxZf9). Come chat with us about **emulator-related topics** on [Discord](https://discord.gg/Q9mxZf9).
For developer chat join `#dev` but stay on topic. Lurking is not only fine, but encouraged! For developer chat join `#dev` but stay on topic. Lurking is not only fine, but encouraged!
Please check the [FAQ](https://github.com/xenia-project/xenia/wiki/FAQ) page before asking questions. Please check the [FAQ](https://github.com/xenia-project/xenia/wiki/FAQ) page before asking questions.
@ -23,26 +20,24 @@ Discussing illegal activities will get you banned.
Buildbot | Status | Releases Buildbot | Status | Releases
-------- | ------ | -------- -------- | ------ | --------
[Windows](https://ci.appveyor.com/project/benvanik/xenia/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/ftqiy86kdfawyx3a/branch/master?svg=true)](https://ci.appveyor.com/project/benvanik/xenia/branch/master) | [Latest](https://github.com/xenia-project/release-builds-windows/releases/latest) ◦ [All](https://github.com/xenia-project/release-builds-windows/releases) Windows | [![CI](https://github.com/xenia-canary/xenia-canary/actions/workflows/CI.yml/badge.svg?branch=canary_experimental)](https://github.com/xenia-canary/xenia-canary/actions/workflows/CI.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/cd506034fd8148309a45034925648499)](https://app.codacy.com/gh/xenia-canary/xenia-canary/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) | [Latest](https://github.com/xenia-canary/xenia-canary/releases/latest) ◦ [All](https://github.com/xenia-canary/xenia-canary/releases)
[Linux](https://cloud.drone.io/xenia-project/xenia) | [![Build status](https://cloud.drone.io/api/badges/xenia-project/xenia/status.svg)](https://cloud.drone.io/xenia-project/xenia) Linux | Curently unsupported
Netplay Build | | [Latest](https://github.com/AdrianCassar/xenia-canary/releases/latest)
Quite a few real games run. Quite a few don't.
See the [Game compatibility list](https://github.com/xenia-project/game-compatibility/issues)
for currently tracked games, and feel free to contribute your own updates,
screenshots, and information there following the [existing conventions](https://github.com/xenia-project/game-compatibility/blob/master/README.md).
## 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
(you'd be surprised what's indexed on Google...).
## Quickstart ## Quickstart
See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page. See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page.
## FAQ
See the [frequently asked questions](https://github.com/xenia-project/xenia/wiki/FAQ) page.
## Game Compatibility
See the [Game compatibility list](https://github.com/xenia-project/game-compatibility/issues)
for currently tracked games, and feel free to contribute your own updates,
screenshots, and information there following the [existing conventions](https://github.com/xenia-project/game-compatibility/blob/master/README.md).
## Building ## Building
See [building.md](docs/building.md) for setup and information about the See [building.md](docs/building.md) for setup and information about the
@ -67,6 +62,10 @@ that there are some major work areas still untouched:
See more projects [good for contributors](https://github.com/xenia-project/xenia/labels/good%20first%20issue). It's a good idea to ask on Discord and check the issues page before beginning work on See more projects [good for contributors](https://github.com/xenia-project/xenia/labels/good%20first%20issue). It's a good idea to ask on Discord and check the issues page before beginning work on
something. something.
## FAQ ## Disclaimer
See the [frequently asked questions](https://github.com/xenia-project/xenia/wiki/FAQ) page. 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
(you'd be surprised what's indexed on Google...).