Update README.md

2024-11-25 15:35:38 +00:00 · 2023-10-23 16:24:27 +00:00 · 2023-10-23 16:24:27 +00:00 · 62acc5203d
parent 3cf8c2e54e
commit 62acc5203d
1 changed files with 47 additions and 42 deletions
--- a/README.md
+++ b/README.md
@ -2,13 +2,6 @@
    <img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="600"/>
 </p>
 ![Flathub](https://img.shields.io/flathub/downloads/net.retrodeck.retrodeck)
 ![Flathub](https://img.shields.io/flathub/v/net.retrodeck.retrodeck)
 ![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
 ![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
 [![Documentation Status](https://readthedocs.org/projects/retrodeck/badge/?version=latest)](https://retrodeck.readthedocs.io/en/latest/?badge=latest)
 # RetroDECK on your device!
 <p float="center">
@ -19,35 +12,26 @@
 </p>
 <br/>
-## What is RetroDECK?
+![Flathub](https://img.shields.io/flathub/downloads/net.retrodeck.retrodeck)
-RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) powered application that builds in a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in a tidy contained flatpak sandbox environment. It's inspired by embedded emulation systems like AmberELEC, EmuELEC, CoreELEC, Lakka, and Batocera.
+![Flathub](https://img.shields.io/flathub/v/net.retrodeck.retrodeck)
 ![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
 ![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
 [![Documentation Status](https://readthedocs.org/projects/retrodeck/badge/?version=latest)](https://retrodeck.readthedocs.io/en/latest/?badge=latest)
-You can also check out our: [Flathub Page](https://flathub.org/apps/net.retrodeck.retrodeck)<br/>
+# What is RetroDECK?
 Instead of having several different software on your system for a variety of emulators and frontends you only need to have one: RetroDECK.
 RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered flatpak application that builds in a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package. 
-## What devices/systems does RetroDECK support: 
+It's inspired by embedded emulation systems like AmberELEC, EmuELEC, CoreELEC, Lakka, and Batocera. 
 The RetroDECK team consists of several veterans for some of the projects mentioned. 
-### Steam Deck
+RetroDECK adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them. 
-Supported from the start and RetroDECK is tailored to the Steam Deck during the beta period. The goal is that all the configurations are ready out-of-the-box and optimized towards the Steam Deck.
+For the long term vision and support you can check out the following wiki page:
-### Linux Desktop
+[RetroDECK: Visions and Goals](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Visions-and-Goals)
 Technically it is working, but the user experience might not be that great it could contain desktop specific bugs and other issues.
 You will also need to manually configure the input to match your desktop and might need to tweak more settings. If you want to try it make sure that your distribution has flatpak support (else you will need to install it).<br>
 We will start to have a bigger desktop focus after the beta period is over.
-### Other SteamOS or Linux handheld gaming devices with flatpak support
+### The RetroDECK community:
 We do plan to support other SteamOS based devices in the future. But during the BETA we are focusing on the Steam Deck.<br/> 
 You can get it to run on other Linux based devices it is not just as seamless as we want it to be and does not live up to our higher standards.<br/> 
 You will need to manually configure the input to match your device and might need to tweak more settings if you try it on a none Steam Deck device. There might also be some hardware specific bugs. 
 ## Do you have any plans for other systems? 
 RetroDECK does not have plans to support Windows, macOS, Android, or iOS.<br>For similar functionality on Windows you could explore [Retrobat](https://www.retrobat.org/) as an alternative.
 ## How do I install RetroDECK?
 Read and follow the guide here: [How to: Start using RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Start-using-RetroDECK) on the Wiki
 ## The RetroDECK community:
 [Website](https://retrodeck.net) <br/>
 [Wiki](https://github.com/XargonWan/RetroDECK/wiki) <br/>
@ -55,23 +39,44 @@ Read and follow the guide here: [How to: Start using RetroDECK](https://github.c
 [Lemmy](https://lemmy.zip/c/retrodeck)<br/>
 [Subreddit](https://www.reddit.com/r/retrodeck)
 ## Is RetroDECK in Beta?
 Yes, here you can read more about the beta period:
-# Short FAQ
+[RetroDECK: Beta period](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Beta-period)
-Please read the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
+# How do I start using RetroDECK?
 We have an in depth How To on how to get started over here: 
 [How to: Start using RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Start-using-RetroDECK)
 ## What devices/systems does RetroDECK support: 
 RetroDECK currently supports:
 - Steam Deck
 - Linux Desktop
 For more information read up here:
 [Supported Systems](https://github.com/XargonWan/RetroDECK/wiki/RetroDECK%3A-Supported-Systems)
 ## Do I have to partition or format my disk/sdcard to install it?
 No, partitioning or formatting is not needed at all. RetroDECK (differently from AmberELEC, Batocera and others) comes as a flatpak. Just install it as any other application and launch it from your desktop and/or Steam library. 
 ## Can I contribute to the project?
-Yes! Everybody is welcome to contribute in any way possible if it is personal time or funds, just check out our [Discord](https://discord.gg/Dz3szYsP8g)!
+
- Do you know how to code and want to contribute? Please join the development team! 
+Yes, off course! <br>
- Maybe you know graphics, art or UI & UX design? Join the discussion!
+Read up here on how to help out, there is something for everyone:
- You can just help by helping others in the support or guide people on various social media and communication platforms.
+
- You can also help by just finding and testing the best configurations for the emulators and the roms.
+[How to: Contribute to RetroDECK](https://github.com/XargonWan/RetroDECK/wiki/How-to%3A-Contribute-to-RetroDECK)
- Or just help us by doing bug reports on all the issues you find (please check old issues first before submitting a new one).
+
- By joining the ✨-new-helpers-start-here channel on [Discord](https://discord.gg/Mv3GZnwrE8) and keeping an eye on the [issues](https://github.com/XargonWan/RetroDECK/issues) tab as well as the [Roadmap](https://github.com/XargonWan/RetroDECK/milestones) tab, you can be up to speed on the latest developments on RetroDECK.
+
- We have a [Patreon](https://www.patreon.com/RetroDECK) page if you want to help us keep our build servers running or just buy us a beverage
+# The RetroDECK Wiki
 Please check out the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
 ## The FAQ
 The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and awnsers. 
 ###### The Steam Deck logo is a registered trademark of Valve Corporation. This project is in no way officially affiliated with Valve.<br/>