|
| 1 | +<p align="center"> |
| 2 | + <picture> |
| 3 | + <source |
| 4 | + width="256px" |
| 5 | + media="(prefers-color-scheme: dark)" |
| 6 | + srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" |
| 7 | + > |
| 8 | + <img |
| 9 | + width="256px" |
| 10 | + src="assets/revanced-headline/revanced-headline-vertical-light.svg" |
| 11 | + > |
| 12 | + </picture> |
| 13 | + <br> |
| 14 | + <a href="https://revanced.app/"> |
| 15 | + <picture> |
| 16 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" /> |
| 17 | + <img height="24px" src="assets/revanced-logo/revanced-logo.svg" /> |
| 18 | + </picture> |
| 19 | + </a> |
| 20 | + <a href="https://github.com/ReVanced"> |
| 21 | + <picture> |
| 22 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" /> |
| 23 | + <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" /> |
| 24 | + </picture> |
| 25 | + </a> |
| 26 | + <a href="http://revanced.app/discord"> |
| 27 | + <picture> |
| 28 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> |
| 29 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> |
| 30 | + </picture> |
| 31 | + </a> |
| 32 | + <a href="https://reddit.com/r/revancedapp"> |
| 33 | + <picture> |
| 34 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> |
| 35 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> |
| 36 | + </picture> |
| 37 | + </a> |
| 38 | + <a href="https://t.me/app_revanced"> |
| 39 | + <picture> |
| 40 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> |
| 41 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> |
| 42 | + </picture> |
| 43 | + </a> |
| 44 | + <a href="https://x.com/revancedapp"> |
| 45 | + <picture> |
| 46 | + <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png"> |
| 47 | + <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" /> |
| 48 | + </picture> |
| 49 | + </a> |
| 50 | + <a href="https://www.youtube.com/@ReVanced"> |
| 51 | + <picture> |
| 52 | + <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> |
| 53 | + <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> |
| 54 | + </picture> |
| 55 | + </a> |
| 56 | + <br> |
| 57 | + <br> |
| 58 | + Continuing the legacy of Vanced |
| 59 | +</p> |
| 60 | + |
1 | 61 | # π ReVanced Documentation |
2 | 62 |
|
3 | | -Documentation for ReVanced. Also contains guides, walkthroughs, and tutorials. |
| 63 | +Collection of all ReVanced documentation. |
4 | 64 |
|
5 | 65 | ## π Table of contents |
6 | 66 |
|
7 | | -- [π» ReVanced CLI](./docs/revanced-cli) |
8 | | -- [π§© ReVanced Patches](./docs/revanced-patches) |
9 | | -- [π ReVanced Manager](./docs/revanced-manager) |
10 | | -- [π οΈ ReVanced Development](./docs/revanced-development) |
11 | | -- [π ReVanced Reddit](./docs/revanced-external-documentation/reddit) |
| 67 | +- [π ReVanced Manager](./docs/revanced-manager): Documentation and usage guides for ReVanced Manager |
| 68 | +- [π» ReVanced CLI](./docs/revanced-cli): Documentation and usage guides for ReVanced CLI |
| 69 | +- [π ReVanced Patcher](./docs/revanced-patcher): Documentation and usage guides for ReVanced Patcher |
| 70 | +- [π οΈ ReVanced Development](./docs/revanced-development): Documentation to setup a development environment for ReVanced |
| 71 | +- [π ReVanced Other](./docs/revanced-other): Miscellaneous documents used on our platforms, such as Reddit or Discord |
| 72 | + |
| 73 | +> [!WARNING] |
| 74 | +> Under `docs/` you will find symbolic links to the documentation of the respective repositories. |
| 75 | +> |
| 76 | +> 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/`. |
| 77 | +
|
| 78 | +## π Get started |
| 79 | + |
| 80 | +1. Checkout the repository recursively: |
| 81 | + |
| 82 | + ```sh |
| 83 | + git clone -c core.symlinks=true https://github.com/revanced/revanced-documentation --recursive && cd revanced-documentation |
| 84 | + git submodule update --remote |
| 85 | + ``` |
| 86 | + |
| 87 | +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/) |
| 88 | + |
| 89 | +## π Licence |
| 90 | + |
| 91 | +ReVanced Documentation is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information. |
| 92 | +[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. |
| 93 | +Any modifications to ReVanced Documentation must also be made available under the GPL, |
| 94 | +along with build & install instructions. |
0 commit comments