From 95cf636a49f3c432353642bc7e4ab0f3c109c5a2 Mon Sep 17 00:00:00 2001 From: Adam Campbell Date: Tue, 21 Jul 2020 15:09:21 +1000 Subject: [PATCH] Update docs to flesh out building the project and xcframeworks --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 536c1130..a7bcf899 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ The Afterpay iOS SDK provides conveniences to make your Afterpay integration exp - [SwiftUI](#swiftui) - [Examples](#examples) - [Building](#building) + - [Mint](#mint) + - [Running](#running) + - [XCFramework](#xcframework) - [Contributing](#contributing) - [License](#license) @@ -205,11 +208,19 @@ The [example project][example] demonstrates how to include an Afterpay payment f # Building +## Mint + The Afterpay SDK uses [Mint][mint] to install and run Swift command line packages. This has been pre-compiled and included in the repository under the [`Tools/mint`][mint-directory] directory, meaning it does not need to be installed or managed externally. > **NOTE:** Mint will automatically download the packages it manages on demand. To speed up the initial build of the SDK, the packages can be downloaded by running the [`Scripts/bootstrap`][bootstrap] script. -Building the project is as simple as cloning the repository, opening [`Afterpay.xcworkspace`][afterpay-workspace] and building the `Afterpay` target. The example project can be built and run via the `Example` target. +## Running + +Building and running the project is as simple as cloning the repository, opening [`Afterpay.xcworkspace`][afterpay-workspace] and building the `Afterpay` target. The example project can be built and run via the `Example` target. + +## XCFramework + +A `.xcframework` can be generated by running the included [`create-xcframework`][create-xcframework]. # Contributing @@ -226,6 +237,7 @@ This project is licensed under the terms of the Apache 2.0 license. See the [LIC [bootstrap]: Scripts/bootstrap [carthage]: https://github.com/Carthage/Carthage [contributing]: CONTRIBUTING.md +[create-xcframework]: Scripts/create-xcframework [example]: Example [git-submodule]: https://git-scm.com/docs/git-submodule [latest-release]: https://github.com/afterpay/sdk-ios/releases/latest