aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 06579084784ffcf381a620f113223809a1497642 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# CyanogenMod Platform SDK

The Platform SDK provides a set of APIs that give you easy access to a variety of different features within CyanogenMod. The SDK exposes APIs and system level framework access in the Android framework that aren't available in any other distribution.

## Setup

You can either [download](https://github.com/CyanogenMod/android_prebuilts_cmsdk/tree/master/current) from prebuilts hosted on github or pull directly via Gradle.


### Building against release artifacts

Our stable releases are mirrored in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22platform.sdk%22), and you can fetch the current release by setting your `build.gradle` dependencies to

```gradle
dependencies {
    compile 'org.cyanogenmod:platform.sdk:4.+'
}
```

### Building against development snapshots

Within `build.gradle` make sure your `repositories` list sonatype OSS repos for snapshots

```gradle
repositories {
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots/"
    }
}
```

You can target the `future` or `development` branch by setting your `dependencies` for `5.0-SNAPSHOT`

```gradle
dependencies {
    compile 'org.cyanogenmod:platform.sdk:5.0-SNAPSHOT'
}
```

### WIKI

For further inquiries regarding this project, please reference the [wiki](https://github.com/CyanogenMod/cm_platform_sdk/wiki).