mirror of
https://github.com/revanced/revanced-documentation.git
synced 2024-09-26 16:16:29 +02:00
95 lines
4.8 KiB
Markdown
95 lines
4.8 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source
|
|
width="256px"
|
|
media="(prefers-color-scheme: dark)"
|
|
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
|
>
|
|
<img
|
|
width="256px"
|
|
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
|
>
|
|
</picture>
|
|
<br>
|
|
<a href="https://revanced.app/">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
|
|
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://github.com/ReVanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
|
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="http://revanced.app/discord">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://reddit.com/r/revancedapp">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://t.me/app_revanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://x.com/revancedapp">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
|
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
|
</picture>
|
|
</a>
|
|
<a href="https://www.youtube.com/@ReVanced">
|
|
<picture>
|
|
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
|
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
|
</picture>
|
|
</a>
|
|
<br>
|
|
<br>
|
|
Continuing the legacy of Vanced
|
|
</p>
|
|
|
|
# 🗄 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.
|