diff --git a/README.md b/README.md index bb70294..808e29c 100644 --- a/README.md +++ b/README.md @@ -3,34 +3,61 @@ ___ #### Make sure you look through the issues pages to check for a issue already open that describes your problem or idea and give it a thumbs up reaction and add a comment instead of opening a duplicate issue. + +#### Note that issues related to Vanced Manager, Vanced MicroG or Vanced Music do not belong here. You can find more info below. ___ Vanced ## For Vanced ### Have a Vanced bug? -Head over to [Issues Page](https://github.com/YTVanced/Vanced/issues), create a new issue and put `[Bug]` tag as a title prefix +Head over to the [Issues Page](https://github.com/YTVanced/Vanced/issues), create a new issue and put the `[Bug]` tag as a title prefix ### Have a ideas for Vanced? -Head over to [Issues Page](https://github.com/YTVanced/Vanced/issues), create a new issue and put `[Idea]` tag as a title prefix +Head over to the [Issues Page](https://github.com/YTVanced/Vanced/issues), create a new issue and put the `[Idea]` tag as a title prefix ___ Vanced Manager ## Have a Manager bug? -Head over to [Issues Page](https://github.com/YTVanced/VancedManager/issues) +Head over to the [Vanced Manager Issues Page](https://github.com/YTVanced/VancedManager/issues) ___ Vanced MicroG ## Have a Vanced MicroG bug? -Head over to [Issue Page](https://github.com/YTVanced/VancedMicroG/issues) or try the upstream [Issue Page](https://github.com/microg/android_packages_apps_GmsCore) for bugs that are not Vanced MicroG specific. +Head over to the [Vanced MicroG Issues Page](https://github.com/YTVanced/VancedMicroG/issues) ___ Vanced SponsorBlock ## Have a Vanced Music bug? -Sorry but Vanced team doesn't accept Vanced Music issues at this time. +Sorry but we don't provide support for Vanced Music at this time as it is only a side project. Unless your bug breaks the main functionality, it will most likely not be fixed ___ Vanced SponsorBlock ## Have a features request for our SponsorBlock implementation? -Head over to [Issues Page](https://github.com/YTVanced/SponsorBlock/issues) +Head over to the [Vanced SponsorBlock Issues Page](https://github.com/YTVanced/SponsorBlock/issues) ________ +## Creating a Logcat +A logcat is a log of all your system messages. This includes a lot of debug information and also any errors that might have occurred. This info can be very useful for developers in some cases. +We might ask you for one in which case you simply need to follow this guide. Please don't use your own method or a random app as that will most likely not help us. Use one of the following two methods: +#### Creating a logcat using the Android Debug Bridge (adb) on your PC +The Android Debug Bridge (adb) is a really useful tool to interface with your phone from a Terminal on your PC. In this case we will use it to create a logcat. +You will first have to enable USB Debugging on your phone: +- Enable Developer Options. You can do so by going to `Settings > About Phone` and tapping Build Number 7 times +- Now go to `Settings > System > Developer options` and enable Usb Debugging ->- Guide created by gghhkm +Next you have to [download adb](https://developer.android.com/studio/releases/platform-tools) to your PC. +- Extract the zip +- Open a command prompt in this directory. On Windows you can do so by holding shift and right clicking the folder and then pressing `Open Powershell here` + +Now all that's left is to create the actual logcat: +- Run `.\adb shell logcat *:W > logcat.txt`. (Omit the `.\` if you're using Mac/Linux) Don't worry if this prints nothing, thats how it is supposed to be since we're redirecting all output into a text file +- Now do the steps necessary to cause your issue +- Finally, close your Terminal. Now you're done, your logcat can be found in the adb folder +#### Creating a logcat using Termux on your rooted Android +- Install Termux [from the Google Play Store](https://play.google.com/store/apps/details?id=com.termux) +- Open it and run the command `su` and accept the SuperUser prompt to grant Termux root +- Run `logcat *:W > /sdcard/logcat.txt`. Don't worry if this prints nothing, thats how it is supposed to be since we're redirecting all output into a text file +- Now do the steps necessary to cause your issue +- Finally, close Termux. Now you're done, your logcat can be found in the root of your sdcard (the location where you'll also find your Downloads, etc) + +### Guide Contributors +- gghhkm +- Vendicated