You've already forked xenia-edge
mirror of
https://github.com/izzy2lost/xenia-edge.git
synced 2026-07-06 00:20:26 -07:00
Revise README for clarity and remove outdated sections
This commit is contained in:
@@ -6,8 +6,8 @@
|
||||
|
||||
<h1 align="center">Xenia Edge - Xbox 360 Emulator</h1>
|
||||
|
||||
Xenia Edge is yet another experimental fork of the Xenia emulator, mainly based on [Xenia Canary](https://github.com/xenia-canary/xenia-canary) but with the aim of
|
||||
quicker iteration and improvements to Vulkan backend and Linux platform in particular. Windows of course remains fully supported as well and will benefit from changes made here especially with its Vulkan backend.
|
||||
Xenia Edge is yet another experimental fork of the Xenia emulator, originally based on [Xenia Canary](https://github.com/xenia-canary/xenia-canary). The focus is
|
||||
on faster iteration, higher default game compatibility, usability and platform support.
|
||||
|
||||
## Status
|
||||
|
||||
@@ -20,50 +20,4 @@ Releases
|
||||
--------
|
||||
[Latest](https://github.com/has207/xenia-edge/releases/latest) ◦ [All](https://github.com/has207/xenia-edge/releases)
|
||||
|
||||
<h1 align="center">Inherited from Xenia Canary</h1>
|
||||
|
||||
## Quickstart
|
||||
|
||||
See the [Quickstart](https://github.com/xenia-canary/xenia-canary/wiki/Quickstart) page.
|
||||
|
||||
## FAQ
|
||||
|
||||
See the [frequently asked questions](https://github.com/xenia-canary/xenia-canary/wiki/FAQ) page.
|
||||
|
||||
## Game Compatibility
|
||||
|
||||
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/canary/README.md).
|
||||
|
||||
## Building
|
||||
|
||||
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)
|
||||
and be sure to run clang-format!
|
||||
|
||||
## Contributors Wanted!
|
||||
|
||||
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
|
||||
is wide open greenfield fun.
|
||||
|
||||
**For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
|
||||
|
||||
Fixes and optimizations are always welcome (please!), but in addition to
|
||||
that there are some major work areas still untouched:
|
||||
|
||||
* Help work through [missing functionality/bugs in games](https://github.com/xenia-canary/xenia-canary/labels/compat)
|
||||
* Reduce the size of Xenia's [huge log files](https://github.com/xenia-canary/xenia-canary/issues/1526)
|
||||
* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/xenia-canary/xenia-canary/labels/platform-linux)
|
||||
|
||||
See more projects [good for contributors](https://github.com/xenia-canary/xenia-canary/labels/good%20first%20issue). It's a good idea to ask on Discord and check the issues page before beginning work on
|
||||
something.
|
||||
|
||||
## 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...).
|
||||
|
||||
Reference in New Issue
Block a user