From fe37f731030d1958facc6989e5584bec5634cbe5 Mon Sep 17 00:00:00 2001 From: WildCat Date: Sun, 9 Jan 2022 11:34:25 +0800 Subject: [PATCH] Refine README --- README.md | 19 ++++++++++++++++++- hello/README.md | 5 +++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eed7426..c2def50 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ -# Fullstack Examples of uniffi-rs +# Fullstack Examples of UniFFI-rs + +Full documentation of the UniFFI crates can be found [here](https://mozilla.github.io/uniffi-rs/Overview.html). Working in progress +## Prerequisites + +### iOS + +1. Latest Xcode (13.x) +1. Rust toolchains for iOS: `rustup target add aarch64-apple-ios-sim --toolchain nightly && rustup target add aarch64-apple-ios x86_64-apple-ios`. Check installaion: + ```shell + $ rustup target list --installed | grep ios + aarch64-apple-ios + aarch64-apple-ios-sim + x86_64-apple-ios + ``` + Please note that `aarch64-apple-ios-sim` requries the nightly toolchain (). +1. Install `uniffi-bindgen`: `cargo install uniffi_bindgen`, details: + ## License MIT diff --git a/hello/README.md b/hello/README.md index 90497f8..570ddbb 100644 --- a/hello/README.md +++ b/hello/README.md @@ -2,11 +2,16 @@ A shared library for the todo list application, which can be used for Android, iOS and other platforms. +## Prerequisites + +Please refer to the root [README.md](../README.md). ## Binary Size ### iOS +- Generate binaries, xcframework and Swift binding: `make all` + #### With Rust binary: 503K ```shell