randogoth/rust-to-flutter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Flux 2025-01-21 17:07:27 +02:00 • committed by GitHub
parent 5a9338a187
commit 61929a5405
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,28 +1,42 @@
### Rust to Flutter Build Script
This script compiles a Rust library for both Android and iOS and copies the generated libraries to the appropriate Flutter project directories.
#### Features:
- Installs missing cross compilation targets
- Installs missing cross-compilation targets.
- Compiles Rust for Android.
- Conditionally compiles Rust for iOS if running on macOS.
- Optionally includes `x86` and `x86_64` Android targets using the `-x` flag.
- Automatically cleans the build directory before compiling.
- Copies `.so` (Android) and `.a` (iOS) files to the Flutter project.
- Copies `.so` (Android) and `.dylib` (iOS) files to the Flutter project.
#### Usage:
1. Ensure the following are installed:
- `cargo-ndk`: `cargo install cargo-ndk`
- Android NDK (set `ANDROID_NDK_HOME` or `ANDROID_SDK_ROOT`)
- Rust toolchains for iOS targets if compiling on macOS
- `cargo-ndk`: Install via `cargo install cargo-ndk`.
- Android NDK (set `ANDROID_NDK_HOME` or `ANDROID_SDK_ROOT`).
- Rust toolchains for iOS targets if compiling on macOS.
2. Run the script:
```bash
./rust_to_flutter.sh <path_to_rust_project> <path_to_flutter_project>
./rust_to_flutter.sh [-x] <path_to_rust_project> <path_to_flutter_project>
```
#### Example:
```bash
./rust_to_flutter.sh ./rust_project ./flutter_project
```
- The optional `-x` flag includes `x86` and `x86_64` targets for Android.
#### Examples:
- Standard build for Android and (on macOS) iOS:
```bash
./rust_to_flutter.sh ./rust_project ./flutter_project
```
- Include `x86` and `x86_64` targets for Android:
```bash
./rust_to_flutter.sh -x ./rust_project ./flutter_project
```
#### Notes:
- Android libraries are copied to `android/app/src/main/jniLibs/<arch>`.
- iOS libraries are copied to the `ios` directory.
#### Additional Information:
- iOS compilation is skipped automatically if the script is not running on macOS.
- The script checks for missing Rust cross-compilation targets and installs them as needed.