https://github.com/ReVanced/revanced-documentation

🗄 Collection of all ReVanced documentation
https://github.com/ReVanced/revanced-documentation

documentation revanced

Last synced: about 1 month ago
JSON representation

🗄 Collection of all ReVanced documentation

• Host: GitHub
• URL: https://github.com/ReVanced/revanced-documentation
• Owner: ReVanced
• License: gpl-3.0
• Created: 2022-10-28T02:29:03.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T15:47:52.000Z (3 months ago)
• Last Synced: 2024-09-13T09:14:00.947Z (3 months ago)
• Topics: documentation, revanced
• Homepage: https://revanced.app
• Size: 123 KB
• Stars: 253
• Watchers: 14
• Forks: 45
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-ReVanced - Documentation

README

        


  

    

    

  

  


  

     

         

         

     

      

   

       

           

           

       

      

   

       

           

           

       

      

   

       

           

           

       

      

   

      

         

         

      

      

   

      

         

         

      

      

   

      

         

         

     

   

   


   


   Continuing the legacy of Vanced



# 🗄 ReVanced Documentation

Collection of all ReVanced documentation.

## 📖 Table of contents

- [💊 ReVanced Manager](./docs/revanced-manager): Documentation and usage guides for ReVanced Manager

- [💻 ReVanced CLI](./docs/revanced-cli): Documentation and usage guides for ReVanced CLI

- [💉 ReVanced Patcher](./docs/revanced-patcher): Documentation and usage guides for ReVanced Patcher

- [🛠️ ReVanced Development](./docs/revanced-development): Documentation to setup a development environment for ReVanced

- [🟠 ReVanced Resources](./docs/revanced-resources): Miscellaneous documents used on our platforms, such as Reddit or Discord

> [!WARNING]  

> Under [docs](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](repositories).

## 🚀 Get started

1. Checkout the repository recursively:

   ```sh

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

   git submodule update --remote

   ```

2. Open the documentation in a reader of your choice, such as [Visual Studio Code](https://code.visualstudio.com/), [Sublime Text](https://www.sublimetext.com/), or [Typora](https://typora.io/)

## 📜 Licence

ReVanced Documentation is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.

[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) 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.