anddea / revanced-patches

🧩 Patches for ReVanced
https://revanced.app
GNU General Public License v3.0
623 stars 43 forks source link

suggestion: Provide info for setting Sources (and patching) in README.md and the wiki #808

Closed KobeW50 closed 3 months ago

KobeW50 commented 3 months ago

Application

Other

Suggestion description

Problem

This repository lacks information users need to set the sources in patching tools. It also does not specify if inotia00's patching tools should be used (RVX Manager, rvx-builder, etc.), or if the ReVanced tools should be used. (In the Telegram, some of the pinned messages say to use the compose manager from ReVanced)

Solution

Add a table or screenshot to the README and/or the Wiki that shows users how to set the Sources. Here is the markdown you can use to display a table:

|||
|---|---|
| Patches organization | `anddea` |
| Patches source | `revanced-patches` |
| Integrations organization | `anddea` |
| Integrations source | `revanced-integrations` |

Here is a screenshot you can use:

anddea_sources_example

Additionally, specify whether to use inotia00's or ReVanced's patching tools.

Acknowledgements

anddea commented 3 months ago

Never thought it was a big problem (as most people don't visit the GitHub page; instead, they look for community support). People can use any patching tool available, as it’s compatible with everything, at least for now.

Maybe the Wiki would be a better place for that information? We can then update the main README by simply adding a link to the Wiki.

Also, the information about sources is provided in the pinned Discussions question. We can use the same easy-to-copy-and-paste format from this discussion in the Wiki. What do you think?

KobeW50 commented 3 months ago

Sounds good. Thank you

KobeW50 commented 3 months ago

I opened a PR for this (it also contains stuff for the wiki)