Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable Android build #384

Merged
merged 3 commits into from
Apr 2, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add android related readme section
  • Loading branch information
flxoacn committed Apr 2, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 50d5f879e5a1dcad55d01af4db953a36f68ee20a
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -56,7 +56,7 @@ For more details, see [The Future of Bandwhich #275](https://github.com/imsnif/b

### Download a prebuilt binary

If you're on linux, you can download the generic binary from the releases.
If you're on `android` or `linux`, you can download the generic binary from the [releases](https://github.com/imsnif/bandwhich/releases)

### Arch Linux

@@ -123,6 +123,19 @@ The minimum supported Rust version is **1.70.0**.
cargo install bandwhich
```

#### Building from source for Android (`aarch64-linux-android`)

Building for target `aarch64-linux-android` is supported via [cross](https://github.com/cross-rs/cross). Until [#1222](https://github.com/cross-rs/cross/issues/1222) is solved, use the latest HEAD:

```sh
cargo install --git https://github.com/cross-rs/cross.git cross
cross build --release --target aarch64-linux-android
```

Kindly be aware that this process generates a pure binary file and not an APK suitable for installation on any arbitrary Android device.

The Android support for bandwhich beyond its build is *not* endorsed by this project and may be unstable or non-functional.

### OpenWRT

To install `bandwhich` on OpenWRT, you'll need to compile a binary that would fit its processor architecture. This might mean you would have to cross compile if, for example, you're working on an `x86_64` and the OpenWRT is installed on an `arm7`.
Loading