update readme

This commit is contained in:
Ariel Elkin
2020-04-12 15:33:04 +01:00
parent f47fde31b0
commit dbe725c40d
2 changed files with 17 additions and 11 deletions

View File

@@ -21,6 +21,8 @@
1. Open your project's settings, open the *Build Phases* tab. In the *Link Binary with Libraries* section, add **libSTK.a**. 1. Open your project's settings, open the *Build Phases* tab. In the *Link Binary with Libraries* section, add **libSTK.a**.
![][linking_libSTK_screenshot] ![][linking_libSTK_screenshot]
1. In the *Dependencies* section, add "rawwaves"
1. In your project's settings, open the *Build Settings* tab. In the *Search Paths* section, double click on the field to the right of *Header Search Paths*, and add the path to the STK's **include** directory relative to your Xcode project's directory. 1. In your project's settings, open the *Build Settings* tab. In the *Search Paths* section, double click on the field to the right of *Header Search Paths*, and add the path to the STK's **include** directory relative to your Xcode project's directory.
![][header_search_paths_screenshot] ![][header_search_paths_screenshot]
@@ -33,6 +35,8 @@
1. Change the extension of any Objective-C files that import STK files to **.mm**. 1. Change the extension of any Objective-C files that import STK files to **.mm**.
* E.g. **ViewController.m** —> **ViewController.mm** * E.g. **ViewController.m** —> **ViewController.mm**
1. If you use a class that makes use of raw wave files (such as `Mandolin`), make sure you call `Stk::setRawwavePath` beforehand in your code.
See the [iOS Demo project](..projects/demo/iOS%20Demo) for a sample usage. See the [iOS Demo project](..projects/demo/iOS%20Demo) for a sample usage.
@@ -76,17 +80,6 @@ NSBundle *rawwaveBundle = [NSBundle bundleWithURL:[[NSBundle mainBundle] URLForR
stk::Stk::setRawwavePath([[rawwaveBundle resourcePath] UTF8String]); stk::Stk::setRawwavePath([[rawwaveBundle resourcePath] UTF8String]);
``` ```
### rawwaves.bundle: No such file or directory
This means that **rawwaves.bundle** hasn't been copied to the build folder, so you'll need to do it manually:
Select the rawwaves scheme:
![][rawwaves_scheme_screenshot]
Build it (⌘+B) then build your project's main scheme.
### Apple Mach-O Linker Error ### Apple Mach-O Linker Error
This means that **STKLib.a** isn't being linked to your binary. Follow step 2 above in [Setup](#setup). This means that **STKLib.a** isn't being linked to your binary. Follow step 2 above in [Setup](#setup).

View File

@@ -25,6 +25,13 @@
/* End PBXBuildFile section */ /* End PBXBuildFile section */
/* Begin PBXContainerItemProxy section */ /* Begin PBXContainerItemProxy section */
834A47CB24435D350028575A /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = B0779A7E18D376A5004DA9B7 /* STK.xcodeproj */;
proxyType = 1;
remoteGlobalIDString = B0EC337B18CB73480005787B;
remoteInfo = rawwaves;
};
B02FD55218C520D70009ECA9 /* PBXContainerItemProxy */ = { B02FD55218C520D70009ECA9 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy; isa = PBXContainerItemProxy;
containerPortal = B02FD52A18C520D60009ECA9 /* Project object */; containerPortal = B02FD52A18C520D60009ECA9 /* Project object */;
@@ -193,6 +200,7 @@
buildRules = ( buildRules = (
); );
dependencies = ( dependencies = (
834A47CC24435D350028575A /* PBXTargetDependency */,
); );
name = "iOS Demo"; name = "iOS Demo";
productName = "iOS Demo"; productName = "iOS Demo";
@@ -316,6 +324,11 @@
/* End PBXSourcesBuildPhase section */ /* End PBXSourcesBuildPhase section */
/* Begin PBXTargetDependency section */ /* Begin PBXTargetDependency section */
834A47CC24435D350028575A /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
name = rawwaves;
targetProxy = 834A47CB24435D350028575A /* PBXContainerItemProxy */;
};
B02FD55318C520D70009ECA9 /* PBXTargetDependency */ = { B02FD55318C520D70009ECA9 /* PBXTargetDependency */ = {
isa = PBXTargetDependency; isa = PBXTargetDependency;
target = B02FD53118C520D60009ECA9 /* iOS Demo */; target = B02FD53118C520D60009ECA9 /* iOS Demo */;