Getting started

This is a guide to help developers get up to speed with TaxonomyKit. It is geared primarily towards anyone who is new to Mac or iOS development, or has not worked extensively with 3rd-party libraries before.

These step-by-step instructions are written for Xcode 8, using the iOS 10 SDK. If you are using a previous version of Xcode, you may want to update before starting.

Step 1: Download Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following commands:

$ brew update
$ brew install carthage

Step 2: Create a cartfile

Project dependencies to be managed by Carthage are specified in a file called cartfile. Create this file in the same directory as your Xcode project (.xcodeproj) file:

$ touch cartfile
$ open -a Xcode cartfile

You just created the cartfile and opened it using Xcode!

Copy and paste the following line into the Xcode window:

github "tadija/AEXML"
github "gservera/TaxonomyKit" ~> 1.1

You shouldn’t use TextEdit to edit the pod file because TextEdit likes to replace standard quotes with more graphically appealing quotes. This can cause Carthage to get confused and display errors, so it’s best to just use Xcode or another programming text editor.

Step 3: Install Dependencies

Now you can install the dependencies in your project:

$ carthage update

Step 4: Add the built framework to your project

After running carthage update you will find the built TaxonomyKit.framework under the Carthage directory in your project's root. Just add the suitable framework for your project's target platform to your Xcode project and you're ready to go.

Step 5: Dive In!

At this point, everything's in place for you to start using TaxonomyKit. Just @import TaxonomyKit and get to it!