Skip to content

Installation

Julian Goacher edited this page Mar 3, 2017 · 4 revisions

There are currently a couple of ways to use the SDK within a project.

AAR file

AAR files are available in the releases folder under the project root. To use these in a project, copy the AAR file into the project's libs folder and then make the following modifications to the project's build.gradle file:

repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    compile 'com.innerfunction:scffld:0.9.1@aar'
}

(Make sure that the version number in the dependencies section matches the AAR file's version).

Git submodule

The SCFFLD-and repository can be included in an app project as a git submodule. This includes all SCFFLD source code in the app project, and is useful if you want to debug or play around with the core SCFFLD source.

To add SCFFLD as a submodule to an app project -

  • Run git submodule add git@github.com:innerfunction/SCFFLD-and.git within the project root directory (or change the repo URL to https://github.com/innerfunction/SCFFLD-and.git if not using SSH).
  • Depending on your git version, you may then need to run git submodule init followed by git submodule update to initialize and download the SCFFLD module if it wasn't automatically cloned when the submodule was added.
  • Add a reference to the SCFFLD module and its location to the project's settings.gradle:
include ':app', ':scffld'
project(':scffld').projectDir = new File('SCFFLD-and/SCFFLD')
  • Add SCFFLD as a dependency to the project's build.gradle:
dependencies {
    compile project(':scffld')
}

See the git documentation for more details on how to use submodules.

Clone this wiki locally