Getting Started

Prerequisites

  • XCode
  • iOS application target >= 11.0
  • Swift 4+
  • Redbeard Framework

Installation

  1. 1. In your Xcode project's General settings drag in Redbeard.framework into the 'Embedded Binaries' section, this will also have the affect of adding the framework into the 'Linked Frameworks and Libraries' section. Please ensure Copy items if needed is selected before adding the framework and clicking Finish. Screenshot
  2. 2. If you have a unit test project add the parent path to the Redbeard.framework into 'Build Settings' > 'Framework Search Paths' section.
  3. 3. Add a new 'Run Script Phase' in your applications target's 'Build Phases' and paste the following snippet below into the script text field. This step is required to work remove unnecessary simulator related framework content when doing App Store submission or when archiving universal binaries. bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Redbeard.framework/strip-frameworks.sh" Screenshot
  4. 4. Import Redbeard into your source code files as required:
    • Swift: import Redbeard
    • Objective-C: #import <Redbeard/Redbeard.h>
  5. 5. To enable theming add in a JSON filenamed theme.config.json into the bundle with the following content:
    
                                {
                                    "disableDefaultMode": false
                                }
                        
  6. 6. Enjoy :)

What next

Perhaps take a look at one of the following tutorials: