VancedManager/README.md

# Vanced Manager [![Github All Releases](https://img.shields.io/github/downloads/YTVanced/VancedManager/total.svg)](https://github.com/YTVanced/VancedManager/releases/latest) [![Github All Releases](https://img.shields.io/github/release/YTVanced/VancedManager.svg)](https://github.com/YTVanced/VancedManager/releases/latest)
Hi, when we released Vanced 15.05.54, people were upset because it used the .apks format, which was way harder 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 understandable UI and be less than 10mb?" and that's how Vanced Manager was born.  
  
After 3 months of development, we are finally ready to introduce Vanced Manager to the masses. Vanced manager can easily install and uninstall vanced and microg, has various settings for customisation and better experience. The Manager comes with an easy-to-use interface  

##### Background download/installation feature is no longer supported due to problems with some ROMs, please do NOT report issues regarding background activity.

## Contributions
Pull requests should be made to the Dev branch as that is the working branch, master is for release code.

For anyone who wants to provide translations please submit them to https://crowdin.com/project/vanced-manager as we also use it for YouTube Vanced. Any issues with translations should be posted there too.

## TODO
- [ ] Clean up the ViewModel and DataModel code
- [ ] Migrate to Jetpack Compose when it's officially released

## Building [![Build](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml/badge.svg?branch=dev)](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml)
### Using Android Studio
Clone the repo, open it in Android Studio and build the app.

### Using command line
#### On Windows:
```powershell
.\gradlew.bat assembleDebug
```
#### On Linux/macOS:
```bash
chmod +x gradlew
./gradlew assembleDebug
```

## Vanced FAQ
Vanced FAQ (from the faq branch) now available on the playstore! https://play.google.com/store/apps/details?id=com.vanced.faq
Added build section to readme 2021-04-17 16:16:22 +00:00			`# Vanced Manager [![Github All Releases](https://img.shields.io/github/downloads/YTVanced/VancedManager/total.svg)](https://github.com/YTVanced/VancedManager/releases/latest) [![Github All Releases](https://img.shields.io/github/release/YTVanced/VancedManager.svg)](https://github.com/YTVanced/VancedManager/releases/latest)`
Fixed grammar and stuff 2020-06-30 23:40:03 +00:00			`Hi, when we released Vanced 15.05.54, people were upset because it used the .apks format, which was way harder 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.`
updated readme 2020-09-25 13:18:39 +00:00			`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 understandable UI and be less than 10mb?" and that's how Vanced Manager was born.`
updated README for more professional style 2020-06-30 21:06:50 +00:00
updated readme 2020-09-25 13:18:39 +00:00			`After 3 months of development, we are finally ready to introduce Vanced Manager to the masses. Vanced manager can easily install and uninstall vanced and microg, has various settings for customisation and better experience. The Manager comes with an easy-to-use interface`
small fixes 2020-08-12 12:21:23 +00:00
updated readme 2021-04-17 16:04:45 +00:00			`##### Background download/installation feature is no longer supported due to problems with some ROMs, please do NOT report issues regarding background activity.`
moved variant selection to home page 2020-06-23 13:47:20 +00:00
updated readme 2021-04-17 16:04:45 +00:00			`## Contributions`
			`Pull requests should be made to the Dev branch as that is the working branch, master is for release code.`
moved variant selection to home page 2020-06-23 13:47:20 +00:00
updated readme 2021-04-17 16:04:45 +00:00			`For anyone who wants to provide translations please submit them to https://crowdin.com/project/vanced-manager as we also use it for YouTube Vanced. Any issues with translations should be posted there too.`
updated README 2020-09-15 18:19:04 +00:00
updated readme 2021-04-17 16:04:45 +00:00			`## TODO`
fixed readme 2021-04-17 16:06:53 +00:00			`- [ ] Clean up the ViewModel and DataModel code`
			`- [ ] Migrate to Jetpack Compose when it's officially released`
moved variant selection to home page 2020-06-23 13:47:20 +00:00
Added build section to readme 2021-04-17 16:16:22 +00:00			`## Building [![Build](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml/badge.svg?branch=dev)](https://github.com/YTVanced/VancedManager/actions/workflows/debug.yml)`
updated readme 2021-04-18 18:01:52 +00:00			`### Using Android Studio`
Added build section to readme 2021-04-17 16:16:22 +00:00			`Clone the repo, open it in Android Studio and build the app.`

updated readme 2021-04-18 18:01:52 +00:00			`### Using command line`
Updated build instructions 2021-04-17 16:19:25 +00:00			`#### On Windows:`
			```powershell
			`.\gradlew.bat assembleDebug`
			```
			`#### On Linux/macOS:`
			```bash
			`chmod +x gradlew`
			`./gradlew assembleDebug`
			```

updated readme 2021-04-17 16:04:45 +00:00			`## Vanced FAQ`
			`Vanced FAQ (from the faq branch) now available on the playstore! https://play.google.com/store/apps/details?id=com.vanced.faq`