Xargon/Cooker
1
0
Fork 0
mirror of https://github.com/RetroDECK/Cooker.git synced 2024-11-23 21:55:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source 
Fixed links
This commit is contained in:
Lazorne 2024-08-08 05:48:49 +00:00 committed by GitHub
parent 55602832b4
commit 1a91be9e61
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -3,26 +3,23 @@
<img src="https://github.com/RetroDECK/RetroDECK-cooker/blob/main/cooker.png?raw=true" alt="RetroDECK-cooker logo" width="700"/>
# What is RetroDECK Cooker?
RetroDECK Cooker are the bleeding edge development builds of [RetroDECK](https://github.com/RetroDECK/RetroDECK). These builds are only for development and testing purposes.
## What is RetroDECK Cooker?
## 🛑 Warning! Backup before testing! 🛑
These builds can make you loose all data including `ROMS`, `BIOS` and `Scraped Data` etc..
We recomend that you don't run Cooker builds on your main gaming machine and wait for Stable Releases.
RetroDECK Cooker are the bleeding edge almost daily development builds of [RetroDECK](https://github.com/RetroDECK/RetroDECK).
## 🛑 Warning! Expect bugs and issues! 🛑
These builds can contain several bug and should be seen as unstable.
🛑 **Warning! Backup before testing and expect bugs!** 🛑
# Can I help you with testing?
Yes, do the backups above and tell in Discord channel `i-want-to-help` that you are interested in testing out Cooker builds.
You will get some instructions from one of the mods and be promoted to a `BetaTester` role.
These builds are only for development and testing purposes. They will contain several bugs and should be seen as unstable.
## Can I contribute to the project in another way?
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/WDc5C9YWMx)!
- Do you know how to code and want to contribute? Please join the development team!
- Maybe you know graphics, art or UI & UX design? Join the discussion!
- 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.
- 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](discord.gg/WDc5C9YWMx) and keeping an eye on the [issues](https://github.com/RetroDECK/RetroDECK/issues) tab as well as the [Roadmap](https://github.com/RetroDECK/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
## Can I help you with testing?
Yes, everyone is free to download the cooker builds and test them, but we recommend that you follow the following wiki links and read up before you do so:
- [Cooker FAQ](https://retrodeck.readthedocs.io/en/latest/wiki_development/testing/faq-cooker/)
- [Cooker Testing - Guide](https://retrodeck.readthedocs.io/en/latest/wiki_development/testing/cooker-testing/)
## Can I contribute to RetroDECK in some another way?
Yes, read more here:
- [How to Contribute](https://retrodeck.readthedocs.io/en/latest/wiki_community/contibute-rd/)