Skip to content

Commit

Permalink
Update README-iOS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arielelkin committed May 12, 2014
1 parent 540d45d commit 1799064
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion iOS/README-iOS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
This file contains instructions for integrating the STK in Xcode projects and solutions to common integration issues.

##Setup

###If you have [Cocoapods](http://cocoapods.org/)

1. Add `pod 'STK', '~> 4.5'` to your Podfile.

1. Run `pod install`

###If you don't have Cocoapods

1. Clone or [download][download_link] the STK into your project's directory.

1. Open the **STK for iOS** folder, and drag and drop **STK.xcodeproj** into your Xcode project.
Expand Down Expand Up @@ -36,11 +46,23 @@ If this problem doesn't go away:
1. Move the STK directory within your project's directory.
1. Follow step 1 from **Setup**, add `stk/include` to the *Header Search Paths*.

If that doesn't solve it:
Install Cocoapods and use it to install the STK. It takes one minute and will make your life easier. Visit the [Cocoapods website](http://cocoapods.org/) for installation instructions.

###FileRead::open: could not open or find file (../../rawwaves/filename.raw)!

If you use a class that makes use of raw waves (such as `Mandolin`, `Wurley`, or `Rhodey`) you need to copy the STK's raw wave files into your bundle. You'll know you need to if you get this runtime error:
If you use a class that makes use of raw waves (such as `Mandolin`, `Wurley`, or `Rhodey`) you need to make sure that the STK's raw wave files are copied into your bundle and that the STK knows where they are. You'll know you need to if you get this runtime error:
`FileRead::open: could not open or find file (../../rawwaves/filename.raw)!`

####If you're using Cocoapods

Add this code before using a class that needs the raw waves:
```objective-c
stk::Stk::setRawwavePath([[[NSBundle mainBundle] pathForResource:@"rawwaves" ofType:@"bundle"] UTF8String]);
```
####If you're not using Cocoapods
1. Open your project's settings, open the *Build Phases* tab.
1. In the *Copy Bundle Resources*, drag and drop **rawwaves.bundle** (it's located in **STK.xcodeproj**'s **Helpers** folder).
1. Then add this code before using a class that needs the raw waves:
Expand Down

0 comments on commit 1799064

Please sign in to comment.