revanced-documentation

                       

Continuing the legacy of Vanced

🗄 ReVanced Documentation

Collection of all ReVanced documentation.

📖 Table of contents

• 💊 ReVanced Manager: Documentation and usage guides for ReVanced Manager
• 💻 ReVanced CLI: Documentation and usage guides for ReVanced CLI
• 💉 ReVanced Patcher: Documentation and usage guides for ReVanced Patcher
• 🛠️ ReVanced Development: Documentation to setup a development environment for ReVanced
• 🟠 ReVanced Resources: Miscellaneous documents used on our platforms, such as Reddit or Discord

[!WARNING]
Under docs you will find symbolic links to the documentation of the respective repositories.

Because GitHub does not render symbolic links, you need to clone this repository recursively to see the content of the linked directories or browse the submodules directly under repositories.

🚀 Get started

1. Checkout the repository recursively:

   git clone -c core.symlinks=true https://github.com/revanced/revanced-documentation --recursive && cd revanced-documentation
   git submodule update --remote

1. Open the documentation in a reader of your choice, such as Visual Studio Code, Sublime Text, or Typora

📜 Licence

ReVanced Documentation is licensed under the GPLv3 license. Please see the license file for more information. tl;dr you may copy, distribute and modify ReVanced Documentation as long as you track changes/dates in source files. Any modifications to ReVanced Documentation must also be made available under the GPL, along with build & install instructions.