Create README.md
Browse files
README.md
ADDED
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Breeze2 Android Demo APK
|
2 |
+
|
3 |
+
This repository hosts the APK file for the Breeze2 Android Demo application, an offline AI assistant that runs completely on-device.
|
4 |
+
|
5 |
+
## Download Links 📱
|
6 |
+
|
7 |
+
| Version | Release Date | Size | Link |
|
8 |
+
|---------|--------------|---------|------|
|
9 |
+
| release/0.1 | 2025-02-18 | 185MB | [Download APK](https://huggingface.co/files/MediaTek-Research/Breeze2-android-demo/breeze2-demo-v1.0.0.apk) |
|
10 |
+
|
11 |
+
## Installation Instructions 🔧
|
12 |
+
|
13 |
+
1. Download the APK from the link above
|
14 |
+
2. Enable "Install from Unknown Sources" in your Android settings
|
15 |
+
3. Install the APK on your device
|
16 |
+
|
17 |
+
> [!WARNING]
|
18 |
+
> After installing the APK, you'll need to download and set up the required model files. Please follow the setup instructions in our [main repository](https://github.com/mtkresearch/Breeze2-android-demo?tab=readme-ov-file#setup).
|
19 |
+
|
20 |
+
## System Requirements 📱
|
21 |
+
|
22 |
+
- Android 8.0 (API level 26) or higher
|
23 |
+
- At least 8GB RAM
|
24 |
+
- Minimum 10GB free storage space
|
25 |
+
|
26 |
+
## Source Code 💻
|
27 |
+
|
28 |
+
Visit our [GitHub repository](https://github.com/mtkresearch/Breeze2-android-demo?tab=readme-ov-file#setup) for:
|
29 |
+
- Complete source code
|
30 |
+
- Detailed documentation
|
31 |
+
- Model setup instructions
|
32 |
+
- Contributing guidelines
|
33 |
+
|
34 |
+
|
35 |
+
---
|
36 |
+
|
37 |
+
For issues and support, please use the [GitHub Issues](https://github.com/mtkresearch/Breeze2-android-demo/issues) page.
|