History

Gregory Burd 4b1583473e Fix more issues identified by clippy (aka: lint).		2020-08-07 09:15:36 -04:00
..
src	Fix more issues identified by clippy (aka: lint).	2020-08-07 09:15:36 -04:00
Cargo.toml	Minor version adjustments and fixes.	2020-05-25 10:51:22 -04:00
README.md	Android SDK basic sample project and symlinked SDK Mentat binaries (#729 ) r=nalexander	2018-06-01 12:44:31 -07:00

README.md

Development flow for Mentat FFI

Android SDK

Android Mentat SDK is one of two first-party consumers (the other one being iOS Mentat SDK).

Binaries produced by cargo build ... are symlinked from within the SDK, and a number of target-specific libmentat_ffi.so binaries are bundled together and distributed with the SDK.

There is a build script at <mentat_root>/scripts/android_build.sh which knows how to cross-compile mentat_ffi for various Android targets.

./<mentat_root>/scripts/android_build.sh - compiles for all supported targets
./<mentat_root>/scripts/android_build.sh x86 - compiles for x86
./<mentat_root>/scripts/android_build.sh x86 arm - compiles for x86, arm

General development flow while working on the Android SDK is:

(pre) compile for all targets, if you've never done so
make changes to mentat_ffi and/or mentat
re-compile mentat_ffi binaries using ./android_build.sh x86. During development it's faster to compile just for the target which matches your emulator, e.g. x86
make corresponding changes in the Android SDK, try them out from within the bundled sample project
since binaries are symlinked, no manual copy step is necessary for the Android SDK to pick up the changes

iOS SDK

TODO, contribute via issue #732.