diff --git a/README.md b/README.md index 1c1d9bc1..35b1214b 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ For more information read up here: [Supported Systems](https://retrodeck.readthedocs.io/en/latest/wiki_general/supported-devices/) ## What is RetroDECK? -RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK Framework` it builds-in and manage 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. +RetroDECK is an [ES-DE](https://es-de.org) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK Framework` it builds-in and manage 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. ### So what does that mean? It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK configures them for you and puts them into one application you can download from Flathub. @@ -60,15 +60,19 @@ The `RetroDECK Configurator` is a `Utility` that exposes some parts of the `Retr It can help with: +- Sync your favorite games with `Steam` +- Run your games with a simple double click from a Desktop environment thanks to the [RetroENGINE](https://retrodeck.readthedocs.io/en/latest/wiki_system_guides/retroengine/retroengine-guide/) +- Check your `BIOS` files +- Auto installing some free `BIOS`es - Compressing games - Easier `Texture Pack` and `Mod` management - File management -- Tools for troubleshooting (BIOS Checker, Multi-File Structure Checker, Partial or full reset of functions) -- Auto installing some free BIOSes +- Tools for troubleshooting (Multi-File Structure Checker, Partial or full reset of functions) - Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers -- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more +- Easier management of `roms`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more - Give access to global presets that can be activated to configure things over many emulators in one go like: `RetroAchievements` - `Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games` +`Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games` + For our long term vision you can check out the following wiki page: [RetroDECK: Visions and Goals](https://retrodeck.readthedocs.io/en/latest/wiki_about/visions-and-goals/) @@ -77,15 +81,18 @@ For our long term vision you can check out the following wiki page: Use the supports channels on [Discord](https://discord.gg/WDc5C9YWMx) `🤝-community-support` and `🆘-support`. ### The RetroDECK community: [Website](https://retrodeck.net)
-[Wiki](https://github.com/RetroDECK/RetroDECK/wiki)
+[Wiki](https://retrodeck.readthedocs.io)
[Discord](https://discord.gg/WDc5C9YWMx)
[Lemmy](https://lemmy.zip/c/retrodeck)
-[Subreddit](https://www.reddit.com/r/retrodeck) +[Bluesky](https://app.bsky.cz/profile/retrodeck.net)
+[Subreddit](https://www.reddit.com/r/retrodeck)
+[Matrix](https://matrix.to/#/#retrodeck:matrix.org) ### Is RetroDECK in Beta? -Yes, here you can read more about the beta period: +Yes, but is perfectly fine and safe for the daily use. +Here you can read more about the beta period: -[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_general/beta-period/) +[RetroDECK: Beta period](https://retrodeck.readthedocs.io/en/latest/wiki_about/what-is-retrodeck/#retrodeck-is-currently-in-in-beta) ### Can I contribute to the project? Yes, off course!
@@ -104,16 +111,13 @@ Please follow [this guide](https://retrodeck.readthedocs.io/en/latest/wiki_devel | [RetroDECK/Wiki](https://github.com/RetroDECK/Wiki) | Where our wiki source code is | | [RetroDECK-website](https://github.com/RetroDECK/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/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/RetroDECK/ES-DE) | This is where we store our patched fork of ES-DE | - -And many more, for the full list please check our [repositories page on GitHub](https://github.com/orgs/RetroDECK/repositories). +| [RetroDECK components](https://github.com/orgs/RetroDECK/repositories) | All the other components can be found under our organization on GitHub | # The RetroDECK Wiki -Please check out the [Wiki](https://github.com/RetroDECK/RetroDECK/wiki) for even more information. +Please check out the [Wiki](https://retrodeck.readthedocs.io) for even more information. ## The FAQ -The RetroDECK [FAQ](https://github.com/RetroDECK/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and answers. +The RetroDECK [FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_faq/faq-rd-general/) pahes on the wiki has a vast variety of questions and answers. Please be sure to check all the FAQ pages. # How to get support? Use the supports channels on [Discord](https://discord.gg/WDc5C9YWMx).