Open-Measurement-SDKiOS

Build Status

Overview

This repository contains the native iOS code of Open Measurement SDK, also known as OM SDK.

Folder Structure

Files are organized as a standard iOS project for Xcode and Cocoapods.

AppVerificationLibrary/

Contains the source code for the SDK.

AppVerificationLibrary-Tests/

Contains the source code for the unit tests.

AppVerificationLibrary.xcodeproj and AppVerificationLibrary.xcworkspace

The Xcode project and workspace.

Config.xcconfig and ConfigTest.xcconfig

Textual configuration files that supplement the settings in the .xcodeproj file.

Podfile and Podfile.lock

Cocoapods configuration files.

docs/

Implementation instructions

Other important files

CHANGELOG.md

All notable changes to the project are documented in the changelog. The format is based on Keep a Changelog.

Config.xcconfig

Xcode configuration file which includes semantic version number and partner namespace of this code release.

Developer Setup

The OM SDK library is built as an Xcode project. The library does not have any external dependencies, but the tests make use of OCMock and XcodeCoverage, which are installed via Cocoapods.

Prerequisites

  • Xcode 8.3 or later
  • Cocoapods 1.2.1 or later — Follow the installation instructions at the Cocoapods website.

Prepare workspace with Cocoapods

If you have a fresh checkout of the Git repo, you need to install the dependencies via Cocoapods. Open a shell in your checkout directory and enter

pod update

After this step, the project is ready to be built.

Building

Build the SDK and run tests using Xcode. Open the workspace file (AppVerificationLibrary.xcworkspace)

  • The AppVerificationLibrary target builds the library.
  • The AppVerificationLibrary-Tests target performs the unit tests.

TO DO: Document how to perform a build using the command line.

Implementation Instructions

Please see the detailed instructions in the docs directory.