Skip to content

Commit bb06657

Browse files
committed
feat: new README
1 parent 6fd17e6 commit bb06657

File tree

4 files changed

+80
-4
lines changed

4 files changed

+80
-4
lines changed

.github/assets/manager-preview.png

198 KB
Loading

.github/assets/manager-preview.psd

2.34 MB
Binary file not shown.

README.md

Lines changed: 70 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,72 @@
1-
# Aliucord Manager [![Crowdin](https://badges.crowdin.net/aliucord-manager/localized.svg)](https://crowdin.com/project/aliucord-manager)
1+
<div align="center">
2+
<img src=".github/assets/manager-preview.png" alt="Aliucord Manager preview" />
3+
<h1>Aliucord Manager</h1>
4+
<p>The new method to install Aliucord, in a user-friendly way.</p>
25

3-
Aliucord Manager - Aliucord Installer rewrite in [Kotlin](https://kotlinlang.org)
4-
and [Jetpack Compose](https://developer.android.com/jetpack/compose).
6+
[![Discord](https://img.shields.io/discord/811255666990907402?logo=discord&logoColor=white&style=for-the-badge&color=5865F2)](https://discord.gg/EsNDvBaHVU)
7+
[![GitHub Stars](https://img.shields.io/github/stars/Aliucord/Manager?logo=github&style=for-the-badge&color=ffd663)](https://github.com/Aliucord/Manager/stargazers)
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/Aliucord/Manager/build.yml?label=Build&logo=github&style=for-the-badge&branch=main)](https://nightly.link/Aliucord/Manager/workflows/android/main/app.zip)
9+
![GitHub Downloads](https://img.shields.io/github/downloads/Aliucord/Manager/total?style=for-the-badge&logo=github)
10+
![Code Size](https://img.shields.io/github/languages/code-size/Aliucord/Manager?logo=github&logoColor=%23fff&style=for-the-badge)
11+
[![GitHub License](https://img.shields.io/github/license/Aliucord/Manager?style=for-the-badge)](https://github.com/Aliucord/Manager/blob/main/LICENSE)
512

6-
INFO: This app is not functional yet, if you want to install Aliucord - [read this](https://github.com/Aliucord/Aliucord#-installation)
13+
</div>
14+
15+
## Prerequisites
16+
17+
Supported Android versions:
18+
19+
- Android 7 (SDK 24) - Android 16 QPR1 (SDK 36)
20+
- Architectures: arm64, armeabi-v7, x86_64, x86
21+
22+
If you have already installed Aliucord before via the old installer app, you can uninstall the
23+
legacy installer. It is deprecated and does not work anymore.
24+
25+
## Installation
26+
27+
1. Download the [latest release APK](https://github.com/Aliucord/Manager/releases/latest)
28+
2. Open and install Aliucord Manager
29+
- If you have not enabled "Install from unknown sources" for your browser via system settings, do so now.
30+
3. Open Aliucord Manager
31+
4. Grant the permission requests
32+
5. Click "New Install"
33+
- You may change how the Aliucord app icon will look once installed.
34+
6. Click "Install" and wait. Do not exit the app while it is running.
35+
- If a failure occurs, it may be due to a variety of reasons:
36+
- Poor internet connection
37+
- Internet censorship / blocks (use a VPN or a different DNS server)
38+
- Insufficient free storage (at least 500MB is recommended)
39+
- If you are stuck, please ask for help in the `#support` channel of our [Discord](https://discord.gg/EsNDvBaHVU0).
40+
7. Click "Launch" or directly launch the newly installed Aliucord app
41+
8. Grant the permission requests
42+
9. Sign in to Discord
43+
10. Install plugins by following these [instructions](https://github.com/aliucord/aliucord#-plugin-installation)
44+
45+
## Building
46+
47+
1. Install the prerequisites:
48+
- Git
49+
- [JDK 21+](https://adoptium.net/temurin/releases/?os=any&arch=any&version=21)
50+
2. Clone the repo:
51+
```shell
52+
git clone https://github.com/rushiiMachine/Manager && cd Manager
53+
```
54+
3. Build the project:
55+
#### Linux/macOS
56+
```shell
57+
chmod +x gradlew && ./gradlew :app:packageStaging --stacktrace
58+
```
59+
#### Windows
60+
```shell
61+
.\gradlew.bat app:assembleDebug
62+
```
63+
4. Built APK will be located at `./app/build/outputs/apk/staging/app-staging.apk`
64+
65+
## Translations
66+
67+
This project handles crowd-sourced translations through Crowdin! If you happen to be fluent in one of the languages listed below,
68+
then please feel free to contribute your translations!
69+
70+
[![Crowdin Translations](https://badges.crowdin.net/badge/light/crowdin-on-dark.png)](https://crowdin.com/project/aliucord-manager)
71+
<br/><br/>
72+
[![Translation Statistics](https://badges.awesome-crowdin.com/translation-15208176-543502.png)](https://crowdin.com/project/aliucord-manager)

TODO.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
- Android API 21 support
2+
- Unified permissions screen like in Aurora Store
3+
- zip-android 64KiB alignment
4+
- zip-android faster file deletion
5+
- Better UI for conflicting package names
6+
- Auto-rename package names when adding new installs...?
7+
- `IconOptionsScreen`
8+
- https://discord.com/channels/811255666990907402/1373756392892272691/1380726498725593220
9+
- Save/Back button at the bottom
10+
- Reset button on PatchOptionsScreen?

0 commit comments

Comments
 (0)