grantjbutler / horus Goto Github PK

A swifty way to handle binary data.

• Requirements
• Installation
• Usage
• License

• iOS 8.0+ / Mac OS X 10.10+ / tvOS 9.0+ / watchOS 2.0+
• Xcode 8.0+

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build Horus 0.1+.

To integrate Horus into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'Horus', '~> 0.1'

Then, run the following command:

$ pod install

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Horus into your Xcode project using Carthage, specify it in your Cartfile:

github "Horus/Horus" ~> 0.1

To use Horus as a Swift Package Manager package just add the following in your Package.swift file.

import PackageDescription

let package = Package(
    name: "HelloHorus",
    dependencies: [
        .Package(url: "https://github.com/caynan/Horus.git", "0.1")
    ]
)

If you prefer not to use either of the aforementioned dependency managers, you can integrate Horus into your project manually.

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

• Add Horus as a git submodule by running the following command:

$ git submodule add https://github.com/caynan/Horus.git
$ git submodule update --init --recursive

• Open the new Horus folder, and drag the Horus.xcodeproj into the Project Navigator of your application's Xcode project.

  It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the Horus.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different Horus.xcodeproj folders each with two different versions of the Horus.framework nested inside a Products folder.

  It does not matter which Products folder you choose from.

• Select the Horus.framework.

• And that's it!

The Horus.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

• Download the latest release from https://github.com/caynan/Horus/releases
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "General" panel.
• Click on the + button under the "Embedded Binaries" section.
• Add the downloaded Horus.framework.
• And that's it!

Horus is released under the MIT license. See LICENSE for details.