Skip to content

Commit ec8f84a

Browse files
committed
chore: update readme
1 parent 5bb8d0d commit ec8f84a

1 file changed

Lines changed: 45 additions & 35 deletions

File tree

README.md

Lines changed: 45 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,107 @@
11
# Auto-Linux (Rust Edition)
22

3-
![Build Status](https://img.shields.io/github/actions/workflow/status/HanSoBored/Auto-Linux/build.yml?branch=main)
4-
![Language](https://img.shields.io/badge/language-Rust-orange)
5-
![Platform](https://img.shields.io/badge/platform-Android%20(Root)-green)
3+
![Build Status](https://img.shields.io/github/actions/workflow/status/HanSoBored/Auto-Linux/build.yml?branch=main)![Language](https://img.shields.io/badge/language-Rust-orange)![Platform](https://img.shields.io/badge/platform-Android%20(Root)-green)
64
![License](https://img.shields.io/badge/license-MIT-blue)
75

8-
**Auto-Linux** is a standalone, lightweight, and blazing fast Linux installer/manager for Android, written entirely in **Rust**. It provides a beautiful Terminal User Interface (TUI) to install, configure, and manage Ubuntu chroots without requiring Termux, Busybox, or external dependencies.
6+
**Auto-Linux** is a lightweight, standalone, and blazing-fast Linux chroot installer and manager for **rooted** Android devices. Written entirely in **Rust**, it provides an elegant Terminal User Interface (TUI) to install, manage, and launch Ubuntu environments without requiring Termux, Busybox, or any external dependencies.
97

10-
> **Built for speed, stability, and ease of use.**
8+
> **Built for power users who demand speed, stability, and simplicity.**
9+
10+
---
11+
12+
## Requirements
13+
14+
* **Root Access:** A rooted Android device (Magisk, KernelSU, APatch, etc.). **This application will not function on non-rooted devices.**
15+
* **Architecture:** ARM64 (`aarch64`) or x86_64.
16+
* **Internet Connection:** Required to download distro root filesystems during installation.
1117

1218
---
1319

1420
## Key Features
1521

16-
* **Native & Standalone:** Compiled as a static binary (`musl`). Zero dependencies. No Termux needed.
17-
* **Beautiful TUI:** Powered by `ratatui`. Keyboard-driven dashboard.
18-
* **Instant Launch:** Switch users and enter Chroot directly from the dashboard.
19-
* **Auto-Configuration:**
20-
* **Network:** Auto-detects DNS and fixes connection issues inside chroot.
21-
* **Users:** Auto-creates User & Password during setup.
22-
* **Sudo:** Auto-configures `sudo` (wheel group) privileges.
23-
* **Mounts:** Handles `/dev`, `/proc`, `/sys`, `/sdcard` binding automatically.
24-
* **Distribution Support:** Ubuntu 20.04 LTS up to 26.04.
25-
* **Root Detection:** Supports Magisk, KernelSU, and APatch natively.
22+
* **Standalone & Zero-Dependency:** Compiled as a single, static binary (`musl`). No dependencies. No Termux needed. Just copy and run.
23+
* **Intelligent Root Handling:**
24+
* **Smart Self-Elevation:** If run as a normal user, the application will automatically attempt to request root privileges to continue.
25+
* **Native Root Detection:** Supports modern root solutions like Magisk, KernelSU, and APatch.
26+
* **Advanced Chroot Management:**
27+
* **Instant Launch:** Enter the chroot as `root` or a standard user directly from the TUI dashboard.
28+
* **Automatic User Detection:** Automatically discovers users created inside the chroot and lists them as login options.
29+
* **Robust Network Resolver:** Implements a custom, `ping`-based DNS resolver to ensure internet connectivity inside the chroot works reliably, even on the strictest Android systems.
30+
* **Fully Automated Setup:**
31+
* **Mounts:** Automatically handles bind mounts for `/dev`, `/proc`, `/sys`, and `/sdcard`.
32+
* **User & Sudo:** Configures a new user with `sudo` privileges (via the wheel group) during the installation process.
33+
* **Wide Distribution Support:** Provides easy access to the latest **Ubuntu Base** releases, including LTS versions (20.04, 22.04, 24.04) and the newest non-LTS releases.
2634

2735
---
2836

2937
## Screenshots
3038

31-
Preview:
39+
*Main Dashboard: System Info & Installed Distros List*
3240
![preview 1](https://raw.githubusercontent.com/HanSoBored/Auto-Linux/main/preview/preview1.jpg)
3341

42+
*Distro Selection for Installation*
3443
![preview 2](https://raw.githubusercontent.com/HanSoBored/Auto-Linux/main/preview/preview2.jpg)
3544

45+
*Installation Process & Chroot Launch*
3646
![preview 3](https://raw.githubusercontent.com/HanSoBored/Auto-Linux/main/preview/preview3.jpg)
3747

3848

3949
---
4050

4151
## Installation
4252

43-
### Option 1: One-Line Install.
44-
Run this command in **Termux**, **ADB Shell**, or any Terminal Emulator:
53+
### Option 1: One-Line Install (Recommended)
54+
Run this command in **Termux**, **ADB Shell**, or any terminal emulator with root access:
4555

4656
```bash
4757
curl -sL https://raw.githubusercontent.com/HanSoBored/Auto-Linux/main/install.sh | sh
4858
```
4959

50-
> **Note:** This script automatically detects if you have Termux installed and creates a shortcut. You can then simply type `autolinux` to start.
60+
> **Note:** This script places the binary in `/data/local/tmp` and creates an `autolinux` shortcut if Termux is detected.
5161
52-
### Option 2: Manual Install
53-
1. Download the latest binary from [Releases](https://github.com/HanSoBored/Auto-Linux/releases).
54-
2. Push to device: `adb push autolinux-aarch64 /data/local/tmp/autolinux`
55-
3. Permission: `chmod +x /data/local/tmp/autolinux`
56-
4. Run: `/data/local/tmp/autolinux`
62+
### Option 2: Manual Installation
63+
1. Download the latest binary from the [Releases](https://github.com/HanSoBored/Auto-Linux/releases) page.
64+
2. Push to your device: `adb push autolinux-aarch64 /data/local/tmp/autolinux`
65+
3. Make it executable: `chmod +x /data/local/tmp/autolinux`
66+
4. Run it (ensure you are in a root shell): `/data/local/tmp/autolinux`
5767

5868
---
5969

6070
## Build from Source
6171

62-
You need **Rust** and **Cross** (for cross-compiling to Android/ARM64 Musl).
72+
You will need **Rust** and **Cross** to cross-compile for the `aarch64-unknown-linux-musl` target.
6373

6474
1. **Install Prerequisites**:
6575
```bash
6676
cargo install cross
6777
```
6878
2. **Build Release**:
6979
```bash
70-
# Static binary (Musl) ensures it runs on any Android version
80+
# The static binary (Musl) ensures it runs on virtually any Android version
7181
cross build --target aarch64-unknown-linux-musl --release
7282
```
7383
3. **Locate Binary**:
74-
The binary will be in `target/aarch64-unknown-linux-musl/release/autolinux`.
84+
The compiled binary will be in `target/aarch64-unknown-linux-musl/release/autolinux`.
7585

7686
---
7787

7888
## Contributing
7989

8090
Contributions are welcome!
81-
1. Fork the project
82-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
83-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
84-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
85-
5. Open a Pull Request
91+
1. Fork the Project.
92+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
93+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
94+
4. Push to the Branch (`git push origin feature/AmazingFeature`).
95+
5. Open a Pull Request.
8696

8797
---
8898

89-
## Disclaimer
99+
## ⚠️ Disclaimer
90100

91-
This tool modifies system partitions (mounting) and creates files in `/data`. While safe, **I am not responsible for any bricked devices or data loss.** Always backup your data.
101+
This tool performs advanced system operations like `mount` and creates files on the `/data` partition. While it has been tested and is considered safe, **I am not responsible for any bricked devices or data loss.** Always back up your important data.
92102

93103
---
94104

95105
## License
96106

97-
Distributed under the MIT License. See [LICENSE](LICENSE)for more information.
107+
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)