e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-11 20:11:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README-iOS.md

Browse Source
This commit is contained in:
Ariel Elkin
2014-05-12 15:22:07 -04:00
parent 540d45dbbd
commit 1799064d6f
1 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
iOS/README-iOS.md
View File

@@ -1,5 +1,15 @@
This file contains instructions for integrating the STK in Xcode projects and solutions to common integration issues.
##Setup ##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. 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. 1. Open the **STK for iOS** folder, and drag and drop **STK.xcodeproj** into your Xcode project.
@@ -36,11 +46,23 @@ If this problem doesn't go away:
1. Move the STK directory within your project's directory. 1. Move the STK directory within your project's directory.
1. Follow step 1 from **Setup**, add `stk/include` to the *Header Search Paths*. 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)! ###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)!` `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. 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. 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: 1. Then add this code before using a class that needs the raw waves: