mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-22 05:55:38 +00:00
87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
<p float="center">
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="600"/>
|
|
</p>
|
|
|
|
# Get RetroDECK working in a few steps!
|
|
|
|
|
|
<p float="center">
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen05.jpeg?raw=true" alt="screenshot" width="300"/>
|
|
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/screenshots/screen06.jpeg?raw=true" alt="screenshot" width="300"/>
|
|
</p>
|
|
|
|
Instead of having several different emulators, engines and frontends on your Linux/SteamOS system you only need one: RetroDECK.
|
|
|
|
|
|
|
|
|
|
|
|
[](https://retrodeck.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
## What is RetroDECK?
|
|
|
|
The wiki has a detailed page on this:
|
|
|
|
[What is RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_about/what-is-retrodeck/)
|
|
|
|
## How do I start using RetroDECK?
|
|
|
|
Read our getting started guide here:
|
|
|
|
[Start using RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_general/retrodeck-start/)
|
|
|
|
## What devices/systems does RetroDECK support:
|
|
|
|
RetroDECK currently supports:
|
|
|
|
- Steam Deck
|
|
- Linux Desktop
|
|
|
|
For more information read here:
|
|
|
|
[Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/)
|
|
|
|
## Is RetroDECK still Beta?
|
|
|
|
Yes, here you can read more about the beta period and our visions for a full release on the wiki:
|
|
|
|
[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/beta-period/)
|
|
|
|
## How to get support and report issues?
|
|
|
|
[Reporting Issues & Known Issues](https://retrodeck.readthedocs.io/en/latest/wiki_bugs/known-issues/)
|
|
|
|
## The RetroDECK community links:
|
|
|
|
- [RetroDECK Website](https://retrodeck.net)
|
|
- [RetroDECK Wiki](https://github.com/XargonWan/RetroDECK/wiki)
|
|
|
|
---
|
|
|
|
- [Discord](https://discord.gg/WDc5C9YWMx)
|
|
- [Matrix](https://matrix.to/#/#retrodeck:matrix.org)
|
|
|
|
---
|
|
|
|
- [Lemmy c/retrodeck](https://lemmy.zip/c/retrodeck)
|
|
- [Subreddit r/retrodeck](https://www.reddit.com/r/retrodeck)
|
|
|
|
|
|
|
|
## Can I contribute to the project?
|
|
|
|
Yes, off course! Read up here:
|
|
|
|
[How-to: Contribute to RetroDECK](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/)
|
|
|
|
## Our repositories:
|
|
| Name | Description |
|
|
|-------------------------------------------------------------|-----------------------------------------------------------|
|
|
| [RetroDECK](https://github.com/XargonWan/RetroDECK) | This one, our main repo where the core of the project is |
|
|
| [RetroDECK-cooker](https://github.com/XargonWan/RetroDECK-cooker) | Where we publish our test build, no code is hosted here |
|
|
| [RetroDECK-Wiki](https://github.com/XargonWan/RetroDECK-Wiki) | Where our wiki source code is |
|
|
| [RetroDECK-website](https://github.com/XargonWan/RetroDECK-website) | Where our website source code is |
|
|
| [RetroDECK on Flathub](https://github.com/flathub/net.retrodeck.retrodeck) | Our little space in Flathub's organization |
|
|
| [RetroDECK-MAME](https://github.com/XargonWan/RetroDECK-MAME) | MAME is big to build, so it's pre-built here and then imported in the build |
|
|
| [RetroDECK-ES-DE](https://github.com/XargonWan/RetroDECK-ES-DE) | This is where we store our patched fork of ES-DE |
|