This document describes how to integrate CleanroomLogger into your application.
CleanroomLogger is designed as a universal Swift framework with support for the following platforms within a single binary:
| Platform | Latest supported OS | Oldest supported OS |
|---|---|---|
| iPhone/iPad | iOS 10.3 | iOS 8.0 |
| Macintosh | macOS 10.12 | macOS 10.9 |
| Apple TV | tvOS 10.2 | tvOS 9.0 |
| Apple Watch | watchOS 3.2 | watchOS 2.0 |
CleanroomLogger uses Swift 3.1 and requires Xcode 8.3 to compile.
There are two supported options for integration:
-
Carthage integration uses the Carthage dependency manager to add CleanroomLogger to your project.
-
Manual integration involves embedding the
CleanroomLogger.xcodeprojfile within your project’s Xcode workspace.
Once properly integrated, you can make use of the API provided by CleanroomLogger in any Swift file using the statement:
import CleanroomLoggerCarthage is a third-party package dependency manager for Apple platforms. As of this writing, the current supported version of Carthage is 0.18.1.
Installing and using Carthage is beyond the scope of this document. If you do not have Carthage installed but would like to use it, you can find installation instructions on the project page.
Within to your project’s root directory, Carthage-based projects will store a file named "Cartfile".
To integrate CleanroomLogger in your workspace, you would start by adding the following line to the Cartfile:
github "emaloney/CleanroomLogger" ~> 5.1.0
This specifies that Carthage use the latest version of CleanroomLogger that is API-compatible with 5.1, i.e. any 5.1.x version.
Note: Be sure to check the latest releases; there may be a newer version than 5.1 that is no longer API-compatible.
Once added to your Cartfile, you can use Carthage to download CleanroomLogger to your machine:
carthage bootstrap --no-build
Normally, Carthage automatically builds framework binaries for all dependencies in the Cartfile. By passing the --no-build argument to carthage bootstrap, Carthage only downloads the dependencies; it doesn't build them. This preserves your option of building the dependencies directly within your own Xcode workspace.
If you do not wish to have Carthage build dependencies that it has downloaded, you can proceed to the Manual Integration section.
To have Carthage build (or re-build) CleanroomLogger, issue the command:
carthage build CleanroomLogger
You can also use the --platform argument to speed up build times by limiting the set of processor architectures that need to be built.
| To build for | Supply the argument |
|---|---|
| iPhone/iPad | --platform ios |
| Macintosh | --platform mac |
| Apple TV | --platform tvos |
| Apple Watch | --platform watchos |
Even though CleanroomLogger is designed as a universal framework, during the build process, Carthage splits the framework into separate binaries for each Apple platform.
After a successful build, you will find platform-specific binaries for CleanroomLogger.xcodeproj in the appropriate Carthage build folder:
| The binary for | Is located in |
|---|---|
| iPhone/iPad | Carthage/Build/iOS |
| Macintosh | Carthage/Build/Mac |
| Apple TV | Carthage/Build/tvOS |
| Apple Watch | Carthage/Build/watchOS |
For further information on integrating Carthage-built frameworks, see the section on "Adding frameworks to an application" in the Carthage documentation.
Open your project window in Xcode, and press ⌘-1 to display the Project Navigator.
In the lefthand pane, select the icon for your project. It will be the top item in the Project Navigator list.
Next, select the Build Target to which you want to add CleanroomLogger.framework, and then select the General tab.
Where you add the framework depends on the type of target you're building. If you're building an application, you'll need to add the framework to the Embedded Binaries section.
Otherwise, it should go into Linked Frameworks and Libraries.
Select the appropriate Build Scheme for your Target, and press ⌘-B to try to build. If all goes well, your integration was successful!
Manual integration involves embedding the Xcode project file for CleanroomLogger directly within your own Xcode workspace.
Successful manual integration depends on the particulars of your project structure and development workflow.
Note: These instructions assume that you are using an Xcode workspace specifically—and not just a project file—in order to integrate CleanroomLogger.
If you use the --no-build flag with Carthage to only downloading dependencies—and not build them—you will want to integrate the project file found at:
Carthage/Checkouts/CleanroomLogger/CleanroomLogger.xcodeproj
If you acquired the CleanroomLogger’s source code through some other means, you will need to locate the CleanroomLogger.xcodeproj project file: .
Open your project window in Xcode, and press ⌘-1 to display the Project Navigator.
Then, using Finder, drag each of the following project files into the top level of the Project Navigator, below your project (and any pre-existing dependencies):
• CleanroomLogger.xcodeproj
Ensure that, as you add each project file, it is placed at the top level of the workspace. It must be parallel to (a sibling of) your own project, and not embedded in another project or folder.
In the lefthand pane of Xcode's Project Navigator, select the icon for your project. It will be the top item in the list.
Next, select the Build Target to which you want to add CleanroomLogger.framework, and then select the General tab.
Where you add the framework depends on the type of target you're building. If you're building an application, you'll need to add the framework to the Embedded Binaries section.
Otherwise, it should go into Linked Frameworks and Libraries.
Select the appropriate Build Scheme for your Target, and press ⌘-B to try to build. If all goes well, your integration was successful!
Want to learn more about CleanroomLogger? Check out the README or the API documentation.
Happy coding!