Skip to content

Commit

Permalink
Update docs to flesh out building the project and xcframeworks
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjcampbell committed Jul 21, 2020
1 parent 18a6a0f commit 95cf636
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down

0 comments on commit 95cf636

Please sign in to comment.