VancedManager/README.md

61 lines
2.6 KiB
Markdown
Raw Normal View History

2021-05-06 12:07:52 +00:00
# Vanced Manager
<div>
[![Github All Releases](https://img.shields.io/github/downloads/YTVanced/VancedManager/total.svg?style=for-the-badge)](https://github.com/YTVanced/VancedManager/releases/latest) [![Github All Releases](https://img.shields.io/github/release/YTVanced/VancedManager.svg?style=for-the-badge)](https://github.com/YTVanced/VancedManager/releases/latest)
</div>
2022-02-01 04:13:36 +00:00
## Introduction
Hi, when we released Vanced 15.05.54, people were upset because it used the .apks format, which was burdensome to install than a traditional .apk file. Even though we wrote clear instructions on how to install the new Vanced build, people still couldn't figure it out.
Then we thought, "why don't we make a manager for vanced, which will download, update and uninstall Vanced and MicroG, have an easy and user-freindly UI and be less than 10mb?" and that's how Vanced Manager was born.
2022-02-01 04:13:36 +00:00
After 3 months of development, we are finally ready to Introduce [Vanced Manager](https://github.com/YTVanced/VancedManager) to the masses!!
## Features
- Vanced manager can easily install and uninstall Vanced and MicroG.
- It has various settings for customization and better experience.
- The Manager comes with an easy-to-use Interface.
</br>
<div class="note">
<p><strong>NOTE: </strong>Background download/installation feature is no longer supported due to problems with some ROMs, please <b>DO NOT</b> report issues regarding background activity.</p>
</div>
2020-08-12 12:21:23 +00:00
2022-02-01 04:13:36 +00:00
<!-- ##### Background download/installation feature is no longer supported due to problems with some ROMs, please do NOT report issues regarding background activity. -->
2020-06-23 13:47:20 +00:00
2021-04-17 16:04:45 +00:00
## Contributions
2022-02-01 04:13:36 +00:00
Pull Requests should be made to the [Dev](https://github.com/YTVanced/VancedManager) Branch as that is the working branch, master is for Release code only.
2020-06-23 13:47:20 +00:00
2022-02-01 04:13:36 +00:00
For anyone who wants to provide translations please submit them to this [link](https://crowdin.com/project/vanced-manager) as we also use it for YouTube Vanced. Any issues with translations should be posted there too.
2020-09-15 18:19:04 +00:00
2021-04-17 16:04:45 +00:00
## TODO
2021-04-17 16:06:53 +00:00
- [ ] Clean up the ViewModel and DataModel code
- [ ] Migrate to Jetpack Compose when it's officially released
2020-06-23 13:47:20 +00:00
2022-02-01 04:13:36 +00:00
## Building
<div>
[![Build](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml/badge.svg?branch=dev)](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml)
</div>
2022-02-01 04:13:36 +00:00
## Using Android Studio
Clone the Repository, open it in Android Studio and build the application.
2021-04-17 16:16:22 +00:00
2022-02-01 04:13:36 +00:00
## Using Command Line
2021-04-17 16:19:25 +00:00
#### On Windows:
```powershell
.\gradlew.bat assembleDebug
```
#### On Linux/macOS:
```bash
chmod +x gradlew
./gradlew assembleDebug
```