Skip to content

Commit

Permalink
add instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Swapnil Tripathi <swapnil06.st@gmail.com>
  • Loading branch information
swaptr committed Aug 25, 2023
1 parent 0a6fe68 commit b84c65d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion uniffi_aries_vcx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,15 @@ Core contains a crate which wraps over the `aries-vcx` crate to provide a UniFFI
Coming soon..

## Building
Coming soon..
This module is distributed in three directories.
1. `core`: The UniFFI bindings for Aries VCX.
2. `demo`: Demo application consuming the UniFFI wrapper code.
3. `scripts`: Contains helper sh scripts to ease the process of setting up, building and generating the UniFFI code.

To set up the Android SDK, NDK and bootstrap the demo application, you can simply run the following scripts in the order:
1. `android.prepare.sh`: This script will prepare the Android SDK and NDK for your system.
2. `android.toolchain.sh`: This script will prepare the required android toolchain.
3. `android.build.sh`: This script will build the UniFFI bindings and will also bootstrap and demo application for the target architecture.

## Support
Currently the builds have been tested for `arm64 (aarch64)` on a physical device. In the future we plan to support most of the architectures.

0 comments on commit b84c65d

Please sign in to comment.