Update README.md

This commit is contained in:
Margen67 2020-05-03 22:09:12 -07:00 committed by illusion
parent 78c728b81d
commit 68d78bd087
1 changed files with 35 additions and 29 deletions

View File

@ -1,37 +1,30 @@
<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/assets/icon">
<img height="120px" src="https://raw.githubusercontent.com/xenia-project/xenia/master/assets/icon/128.png" /> <img height="120px" width="120px" src="https://raw.githubusercontent.com/xenia-canary/xenia-canary/canary/assets/icon/1024.png" />
</a> </a>
</p> </p>
<h1 align="center">Xenia Canary - Xbox 360 Emulator</h1>
<h1 align="center">Xenia - Xbox 360 Emulator</h1> [![Discord Server](https://discordapp.com/api/guilds/533275703882547200/widget.png)](https://discord.gg/jydhhRQ)
[![Actions Status](https://github.com/xenia-canary/xenia-canary/workflows/CI/badge.svg)](https://github.com/xenia-canary/xenia-canary/actions)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/5fs0ia3031l9rbpo/branch/canary_new?svg=true)](https://ci.appveyor.com/project/chris-hawley/xenia-canary/branch/canary_new)
[![Azure Build Status](https://dev.azure.com/xenia-canary/xenia-canary/_apis/build/status/xenia-canary.xenia-canary?branchName=canary_new)](https://dev.azure.com/xenia-canary/xenia-canary/_build/latest?definitionId=1&branchName=canary_new)
<!--[![Travis Build Status](https://travis-ci.org/xenia-canary/xenia-canary.svg?branch=canary)](https://travis-ci.org/xenia-canary/xenia-canary)-->
Xenia is an experimental emulator for the Xbox 360. For more information, see the Xenia Canary is an experimental fork of Xenia. For more information, see the
[main Xenia wiki](https://github.com/xenia-project/xenia/wiki). [wiki](https://github.com/xenia-canary/xenia-canary/wiki).
See current Pull Request status [here](https://github.com/xenia-canary/xenia-canary/wiki/PR-status).
**Interested in supporting the core contributors?** Visit **Interested in supporting the core contributors?** Visit
[Xenia Project on Patreon](https://www.patreon.com/xenia_project). [Xenia Project on Patreon](https://www.patreon.com/xenia_project).
Come chat with us about **emulator-related topics** on [Discord](https://discord.gg/Q9mxZf9). Please check the [FAQ](https://github.com/xenia-canary/xenia-canary/wiki/FAQ) page before asking questions.
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.
We've got jobs/lives/etc, so don't expect instant answers. We've got jobs/lives/etc, so don't expect instant answers.
Discussing illegal activities will get you banned. Discussing illegal activities will get you banned.
## Status ### Disclaimer
Buildbot | Status
-------- | ------
[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)
[Linux](https://travis-ci.org/xenia-project/xenia) | [![Build status](https://travis-ci.org/xenia-project/xenia.svg?branch=master)](https://travis-ci.org/xenia-project/xenia)
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 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 of emulation of modern devices and operating systems. **It is not for enabling
@ -43,30 +36,43 @@ legally purchased devices and games and information made public on the internet
See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page. See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page.
## Download
Windows:
* **[AppVeyor](https://ci.appveyor.com/api/projects/chris-hawley/xenia-canary/artifacts/xenia_canary.zip?branch=canary_new&job=Configuration:%20Release&pr=false)**
* *[GitHub Actions](https://github.com/xenia-canary/xenia-canary/releases/latest/download/xenia_canary.zip)*
## Compatibility
Quite a few real games run. Quite a few don't.
See the [Game compatibility list](https://github.com/xenia-canary/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-canary/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
`xb` script. When writing code, check the [style guide](docs/style_guide.md) `xb` script. When writing code, check the [style guide](docs/style_guide.md)
and be sure to run clang-format! and be sure to run clang-format!
## Contributors Wanted! <!--## Contributors Wanted!
<!--
Have some spare time, know advanced C++, and want to write an emulator? Have some spare time, know advanced C++, and want to write an emulator?
Contribute! There's a ton of work that needs to be done, a lot of which Contribute! There's a ton of work that needs to be done, a lot of which
is wide open greenfield fun. is wide open greenfield fun.
<!--
**For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).** **For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
<!--
Fixes and optimizations are always welcome (please!), but in addition to Fixes and optimizations are always welcome (please!), but in addition to
that there are some major work areas still untouched: that there are some major work areas still untouched:
<!--
* Help work through [missing functionality/bugs in games](https://github.com/xenia-project/xenia/labels/compat) * Help work through [missing functionality/bugs in games](https://github.com/xenia-project/xenia/labels/compat)
* Add input drivers for [DualShock4 (PS4) controllers](https://github.com/xenia-project/xenia/issues/60) (or anything else) * Add input drivers for [DualShock4 (PS4) controllers](https://github.com/xenia-project/xenia/issues/60) (or anything else)
* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/xenia-project/xenia/labels/cross%20platform) * Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/xenia-project/xenia/labels/cross%20platform)
<!--
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 ## FAQ
See the [frequently asked questions](https://github.com/xenia-project/xenia/wiki/FAQ) page. See the [frequently asked questions](https://github.com/xenia-canary/xenia-canary/wiki/FAQ) page.