From 9c5d213d4a26282973279c1a0f663ee15c302cbc Mon Sep 17 00:00:00 2001 From: "Glenn R. Fisher" Date: Wed, 23 Nov 2016 11:13:06 -0600 Subject: [PATCH] Move documentation to docs folder --- README.md | 4 +-- .../encrypt-credentials.md | 0 .../ObjectiveC.md => docs/objective-c.md | 0 .../publishing-release.md | 0 .../quickstart-resources}/01-NewProject.png | Bin .../02-ProjectSettings.png | Bin .../03-CreateCartfile.png | Bin .../04-AddDependency.png | Bin .../05-CarthageUpdate.png | Bin .../06-GeneralSettings.png | Bin .../07-LinkFrameworks.png | Bin .../08-LinkedFrameworks.png | Bin .../09-NewRunScriptPhase.png | Bin .../10-AddCarthageScript.png | Bin .../11-AddInputFiles.png | Bin .../12-OpenAsSourceCode.png | Bin .../13-AppTransportSecurity.png | Bin .../14-ImportFrameworks.png | Bin .../15-SynthesizeText.png | Bin .../Quickstart.md => docs/quickstart.md | 28 +++++++++--------- 20 files changed, 16 insertions(+), 16 deletions(-) rename Documentation/EncryptCredentials.md => docs/encrypt-credentials.md (100%) rename Documentation/ObjectiveC.md => docs/objective-c.md (100%) rename Documentation/PublishingRelease.md => docs/publishing-release.md (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/01-NewProject.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/02-ProjectSettings.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/03-CreateCartfile.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/04-AddDependency.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/05-CarthageUpdate.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/06-GeneralSettings.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/07-LinkFrameworks.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/08-LinkedFrameworks.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/09-NewRunScriptPhase.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/10-AddCarthageScript.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/11-AddInputFiles.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/12-OpenAsSourceCode.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/13-AppTransportSecurity.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/14-ImportFrameworks.png (100%) rename {Documentation/Quickstart-Images => docs/quickstart-resources}/15-SynthesizeText.png (100%) rename Documentation/Quickstart.md => docs/quickstart.md (82%) diff --git a/README.md b/README.md index a98d02372..2f9a56786 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The Watson Developer Cloud iOS SDK makes it easy for mobile developers to build There are many resources to help you build your first cognitive application with the iOS SDK: - Read the [Readme](README.md) -- Follow the [QuickStart Guide](Documentation/Quickstart.md) +- Follow the [QuickStart Guide](docs/quickstart.md) - Review a [Sample Application](#sample-applications) - Browse the [Documentation](http://watson-developer-cloud.github.io/ios-sdk/) @@ -169,7 +169,7 @@ To continue using the iOS SDK with Xcode 7, we recommend following the v0.7.x re ## Objective-C Compatibility -Please see [this tutorial](Documentation/ObjectiveC.md) for more information about consuming the Watson Developer Cloud iOS SDK in an Objective-C application. +Please see [this tutorial](docs/objective-c.md) for more information about consuming the Watson Developer Cloud iOS SDK in an Objective-C application. ## Contributing diff --git a/Documentation/EncryptCredentials.md b/docs/encrypt-credentials.md similarity index 100% rename from Documentation/EncryptCredentials.md rename to docs/encrypt-credentials.md diff --git a/Documentation/ObjectiveC.md b/docs/objective-c.md similarity index 100% rename from Documentation/ObjectiveC.md rename to docs/objective-c.md diff --git a/Documentation/PublishingRelease.md b/docs/publishing-release.md similarity index 100% rename from Documentation/PublishingRelease.md rename to docs/publishing-release.md diff --git a/Documentation/Quickstart-Images/01-NewProject.png b/docs/quickstart-resources/01-NewProject.png similarity index 100% rename from Documentation/Quickstart-Images/01-NewProject.png rename to docs/quickstart-resources/01-NewProject.png diff --git a/Documentation/Quickstart-Images/02-ProjectSettings.png b/docs/quickstart-resources/02-ProjectSettings.png similarity index 100% rename from Documentation/Quickstart-Images/02-ProjectSettings.png rename to docs/quickstart-resources/02-ProjectSettings.png diff --git a/Documentation/Quickstart-Images/03-CreateCartfile.png b/docs/quickstart-resources/03-CreateCartfile.png similarity index 100% rename from Documentation/Quickstart-Images/03-CreateCartfile.png rename to docs/quickstart-resources/03-CreateCartfile.png diff --git a/Documentation/Quickstart-Images/04-AddDependency.png b/docs/quickstart-resources/04-AddDependency.png similarity index 100% rename from Documentation/Quickstart-Images/04-AddDependency.png rename to docs/quickstart-resources/04-AddDependency.png diff --git a/Documentation/Quickstart-Images/05-CarthageUpdate.png b/docs/quickstart-resources/05-CarthageUpdate.png similarity index 100% rename from Documentation/Quickstart-Images/05-CarthageUpdate.png rename to docs/quickstart-resources/05-CarthageUpdate.png diff --git a/Documentation/Quickstart-Images/06-GeneralSettings.png b/docs/quickstart-resources/06-GeneralSettings.png similarity index 100% rename from Documentation/Quickstart-Images/06-GeneralSettings.png rename to docs/quickstart-resources/06-GeneralSettings.png diff --git a/Documentation/Quickstart-Images/07-LinkFrameworks.png b/docs/quickstart-resources/07-LinkFrameworks.png similarity index 100% rename from Documentation/Quickstart-Images/07-LinkFrameworks.png rename to docs/quickstart-resources/07-LinkFrameworks.png diff --git a/Documentation/Quickstart-Images/08-LinkedFrameworks.png b/docs/quickstart-resources/08-LinkedFrameworks.png similarity index 100% rename from Documentation/Quickstart-Images/08-LinkedFrameworks.png rename to docs/quickstart-resources/08-LinkedFrameworks.png diff --git a/Documentation/Quickstart-Images/09-NewRunScriptPhase.png b/docs/quickstart-resources/09-NewRunScriptPhase.png similarity index 100% rename from Documentation/Quickstart-Images/09-NewRunScriptPhase.png rename to docs/quickstart-resources/09-NewRunScriptPhase.png diff --git a/Documentation/Quickstart-Images/10-AddCarthageScript.png b/docs/quickstart-resources/10-AddCarthageScript.png similarity index 100% rename from Documentation/Quickstart-Images/10-AddCarthageScript.png rename to docs/quickstart-resources/10-AddCarthageScript.png diff --git a/Documentation/Quickstart-Images/11-AddInputFiles.png b/docs/quickstart-resources/11-AddInputFiles.png similarity index 100% rename from Documentation/Quickstart-Images/11-AddInputFiles.png rename to docs/quickstart-resources/11-AddInputFiles.png diff --git a/Documentation/Quickstart-Images/12-OpenAsSourceCode.png b/docs/quickstart-resources/12-OpenAsSourceCode.png similarity index 100% rename from Documentation/Quickstart-Images/12-OpenAsSourceCode.png rename to docs/quickstart-resources/12-OpenAsSourceCode.png diff --git a/Documentation/Quickstart-Images/13-AppTransportSecurity.png b/docs/quickstart-resources/13-AppTransportSecurity.png similarity index 100% rename from Documentation/Quickstart-Images/13-AppTransportSecurity.png rename to docs/quickstart-resources/13-AppTransportSecurity.png diff --git a/Documentation/Quickstart-Images/14-ImportFrameworks.png b/docs/quickstart-resources/14-ImportFrameworks.png similarity index 100% rename from Documentation/Quickstart-Images/14-ImportFrameworks.png rename to docs/quickstart-resources/14-ImportFrameworks.png diff --git a/Documentation/Quickstart-Images/15-SynthesizeText.png b/docs/quickstart-resources/15-SynthesizeText.png similarity index 100% rename from Documentation/Quickstart-Images/15-SynthesizeText.png rename to docs/quickstart-resources/15-SynthesizeText.png diff --git a/Documentation/Quickstart.md b/docs/quickstart.md similarity index 82% rename from Documentation/Quickstart.md rename to docs/quickstart.md index 254ad453a..c77a60da4 100644 --- a/Documentation/Quickstart.md +++ b/docs/quickstart.md @@ -6,11 +6,11 @@ This guide contains step-by-step instructions to create an iOS application with 1. Open Xcode and create a new project with the "Single View Application" template. - ![New Project](Quickstart-Images/01-NewProject.png?raw=true) + ![New Project](quickstart-resources/01-NewProject.png?raw=true) 2. Set the product name to "Watson Speaks" and language to "Swift." - ![Project Settings](Quickstart-Images/02-ProjectSettings.png?raw=true) + ![Project Settings](quickstart-resources/02-ProjectSettings.png?raw=true) ## Download and Build the iOS SDK Frameworks @@ -18,7 +18,7 @@ We will use the [Carthage](https://github.com/Carthage/Carthage) dependency mana 1. Create a file in your project directory called `Cartfile`. - ![Create Cartfile](Quickstart-Images/03-CreateCartfile.png?raw=true) + ![Create Cartfile](quickstart-resources/03-CreateCartfile.png?raw=true) 2. Add the following line to your `Cartfile`. This specifies the iOS SDK as a dependency. In a production app, you may also want to specify a [version requirement](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#version-requirement). @@ -26,7 +26,7 @@ We will use the [Carthage](https://github.com/Carthage/Carthage) dependency mana github "watson-developer-cloud/ios-sdk" ``` - ![Add Dependency](Quickstart-Images/04-AddDependency.png?raw=true) + ![Add Dependency](quickstart-resources/04-AddDependency.png?raw=true) 3. Open the Terminal and navigate to your project directory. Then use Carthage to download and build the iOS SDK: @@ -34,7 +34,7 @@ We will use the [Carthage](https://github.com/Carthage/Carthage) dependency mana $ carthage update --platform iOS ``` - ![Carthage Update](Quickstart-Images/05-CarthageUpdate.png?raw=true) + ![Carthage Update](quickstart-resources/05-CarthageUpdate.png?raw=true) Carthage clones the iOS SDK repository and builds a framework for each Watson service in the `Carthage/Build/iOS` directory. It also builds a framework called `RestKit` that is used internally for networking and JSON parsing. @@ -44,17 +44,17 @@ To use the iOS SDK frameworks, we need to link them with our application. 1. In Xcode, navigate to your application target's "General" settings tab. Then scroll down to the "Linked Frameworks and Libraries" section and click the `+` icon. - ![General Settings](Quickstart-Images/06-GeneralSettings.png?raw=true) + ![General Settings](quickstart-resources/06-GeneralSettings.png?raw=true) 2. In the window that appears, choose "Add Other..." and navigate to the `Carthage/Build/iOS` directory. Select the `TextToSpeechV1` and `RestKit` frameworks to link them with your application. - ![Link Frameworks](Quickstart-Images/07-LinkFrameworks.png?raw=true) + ![Link Frameworks](quickstart-resources/07-LinkFrameworks.png?raw=true) We also need to copy the frameworks into our application to make them accessible at runtime. We will use a Carthage script to copy the frameworks and avoid an [App Store submission bug](http://www.openradar.me/radar?id=6409498411401216). 1. In Xcode, navigate to your application target's "Build Phases" settings tab. Then click the `+` icon and add a "New Run Script Phase." - ![New Run Script Phase](Quickstart-Images/09-NewRunScriptPhase.png?raw=true) + ![New Run Script Phase](quickstart-resources/09-NewRunScriptPhase.png?raw=true) 2. Add the following command to the run script phase: @@ -62,7 +62,7 @@ We also need to copy the frameworks into our application to make them accessible /usr/local/bin/carthage copy-frameworks ``` - ![AddCarthageScript](Quickstart-Images/10-AddCarthageScript.png?raw=true) + ![AddCarthageScript](quickstart-resources/10-AddCarthageScript.png?raw=true) 4. Add the frameworks you'd like to use (and the `RestKit` framework) to the "Input Files" list: @@ -71,7 +71,7 @@ We also need to copy the frameworks into our application to make them accessible $(SRCROOT)/Carthage/Build/iOS/RestKit.framework ``` - ![Add Input Files](Quickstart-Images/11-AddInputFiles.png?raw=true) + ![Add Input Files](quickstart-resources/11-AddInputFiles.png?raw=true) ## Add Exception for App Transport Security @@ -79,7 +79,7 @@ To securely connect to IBM Watson services, the application's `Info.plist` file 1. In Xcode, right-click on the `Info.plist` file and choose `Open As -> Source Code`. - ![Open As Source Code](Quickstart-Images/12-OpenAsSourceCode.png?raw=true) + ![Open As Source Code](quickstart-resources/12-OpenAsSourceCode.png?raw=true) 2. Copy-and-paste the following source code into the `Info.plist` file. @@ -103,7 +103,7 @@ To securely connect to IBM Watson services, the application's `Info.plist` file ``` - ![App Transport Security Exception](Quickstart-Images/13-AppTransportSecurity.png?raw=true) + ![App Transport Security Exception](quickstart-resources/13-AppTransportSecurity.png?raw=true) ## Synthesize with Text to Speech @@ -118,7 +118,7 @@ We will modify our project's `ViewController` to synthesize English text with th import AVFoundation ``` - ![Import Frameworks](Quickstart-Images/14-ImportFrameworks.png?raw=true) + ![Import Frameworks](quickstart-resources/14-ImportFrameworks.png?raw=true) 3. Add a `var audioPlayer: AVAudioPlayer!` property to the `ViewController` class. This ensures that the audio player does not fall out of scope and end playback when the `viewDidLoad()` function returns. @@ -137,6 +137,6 @@ We will modify our project's `ViewController` to synthesize English text with th } ``` - ![Synthesize Text](Quickstart-Images/15-SynthesizeText.png?raw=true) + ![Synthesize Text](quickstart-resources/15-SynthesizeText.png?raw=true) 5. Run your application in the simulator to hear the synthesized text!