meta: Improve readme

This commit is contained in:
Wing 2023-04-16 13:35:10 -04:00 committed by GitHub
parent 9e3f4a0b0d
commit a267ebaff0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 63 additions and 2 deletions

View File

@ -1,2 +1,63 @@
# VendettaManager
Easily install Vendetta on Android
<div align="center">
<img src="images/vendetta_logo.png" alt="Vendetta logo" width="200px" style="border-radius: 50%" />
# Vendetta Manager
Easily install Vendetta on Android
[![Latest release](https://img.shields.io/github/v/release/vendetta-mod/VendettaManager?color=3AB8BA&display_name=release&label=Latest&style=for-the-badge)](https://github.com/vendetta-mod/VendettaManager/releases/latest)
---
<br>
![Debug build status](https://img.shields.io/github/actions/workflow/status/vendetta-mod/VendettaManager/build-debug.yml?label=Debug%20Build&logo=github&style=for-the-badge&branch=main)
[![Stars](https://img.shields.io/github/stars/vendetta-mod/VendettaManager?logo=github&style=for-the-badge)](https://github.com/vendetta-mod/VendettaManager/stargazers)
[![Discord](https://img.shields.io/discord/1015931589865246730?logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/n9QQ4XhhJP)
<br>
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/vendetta-mod/VendettaManager?logo=github&logoColor=%23fff&style=for-the-badge)
![Line count](https://img.shields.io/tokei/lines/github/vendetta-mod/VendettaManager?logo=github&logoColor=%23fff&style=for-the-badge)
![GitHub top language](https://img.shields.io/github/languages/top/vendetta-mod/VendettaManager?style=for-the-badge)
<br>
<img src="images/screenshot_home.png" width="200px">
</div>
Build
---
#### Prerequisites
- [Git](https://git-scm.com/downloads)
- [JDK 17](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
- [Android SDK](https://developer.android.com/studio)
#### Instructions
1. Clone the repo
- `git clone https://github.com/vendetta-mod/VendettaManager.git && cd VendettaManager`
2. Build the project
- Linux: `chmod +x ./gradlew && gradlew assembleDebug`
- Windows: `./gradlew assembleDebug`
3. Install on device
- [Enable usb debugging](https://developer.android.com/studio/debug/dev-options) and plug in your phone
- Run `adb install app/build/outputs/apk/debug/app-debug.apk`
## Contributing
This is an open-source project, you can do so without any programming.
Here are a few things you can do:
- [Test and report issues](https://github.com/vendetta-mod/VendettaManager/issues/new/choose)
- [Translate the app into your language](https://crowdin.com/project/vendetta-manager)
License
---
Vendetta is licensed under the Open Software License version 3.0
[![License: OSL v3](https://img.shields.io/badge/License-OSL%20v3-blue.svg?style=for-the-badge)](https://github.com/vendetta-mod/VendettaManager/blob/main/LICENSE)

BIN
images/screenshot_home.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 190 KiB

BIN
images/vendetta_logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB