Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
Merge pull request #11 from unsignedapps/tech/updated-readme-xcode-12
Browse files Browse the repository at this point in the history
Xcode 12 README Updates
  • Loading branch information
bok- authored Jun 23, 2020
2 parents 2d0ed7b + 462fff0 commit e5be919
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

swift-create-xcframework is a very simple tool designed to wrap `xcodebuild` and the process of creating multiple frameworks for a Swift Package and merging them into a single XCFramework.

On the 23rd of June 2020, Apple announced Xcode 12 and Swift 5.3 with support for Binary Targets. Though they provide a simplified way to [include Binary Frameworks in your packages][apple-docs], they did not provide a simple way to create your XCFrameworks, with only some [documentation for the long manual process][manual-docs]. swift-create-xcframework bridges that gap.

**Note:** swift-create-xcframework pre-dates the WWDC20 announcement and is tested with Xcode 11.4 or later, but should work with Xcode 11.2 or later. You can include the generated XCFrameworks in your app manually even without Xcode 12.

## Usage

Inside your Swift Package folder you can just run:
Expand All @@ -19,6 +23,8 @@ Then for every target or product specified, swift-create-xcframework will:
3. Merge the SDK-specific framework into an XCFramework using `xcodebuild -create-xcframework`.
4. Optionally package it up into a zip file ready for a GitHub release.

This process mirrors the [official documentation][manual-docs].

## Choosing what to build

Let's use an example `Package.swift`:
Expand Down Expand Up @@ -156,4 +162,5 @@ Please read the [Contribution Guide](CONTRIBUTING.md) for details on how to cont

swift-create-xcframework is available under the MIT license. See the [LICENSE](LICENSE) file for more info.

[apple-docs]: https://developer.apple.com/documentation/swift_packages/distributing_binary_frameworks_as_swift_packages
[apple-docs]: https://developer.apple.com/documentation/swift_packages/distributing_binary_frameworks_as_swift_packages
[manual-docs]: https://help.apple.com/xcode/mac/11.4/#/dev544efab96
2 changes: 1 addition & 1 deletion Sources/CreateXCFramework/Command.swift
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ struct Command: ParsableCommand {
Supported platforms: \(TargetPlatform.allCases.map({ $0.rawValue }).joined(separator: ", "))
""",
version: "1.0.5"
version: "1.1.0"
)


Expand Down

0 comments on commit e5be919

Please sign in to comment.