README.md
author Da Risk <da_risk@geekorum.com>
Thu, 03 Apr 2025 17:24:24 -0400
changeset 30 763a6573b900
parent 7 b3b2e88f441f
child 75 bcfc8238b4f6
permissions -rw-r--r--
core: refactor OssLicenseParser to use source as constructor params
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
AboutOss
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
==========
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
AboutOss is an utility library to retrieve and display opensource licenses in Android applications.
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
Usage
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
=====
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
The library works with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/master/oss-licenses-plugin). 
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
You can integrate it in your application with few simple steps.
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
### Apply the OSS Licenses Gradle Plugin
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
In your app-level `build.gradle`, apply the plugin by adding the following line under the existing `apply plugin: 'com.android.application'` at the top of the file:
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
```build.gradle.kts
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
apply plugin: 'com.google.android.gms.oss-licenses-plugin'
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
```
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
### Add the ui library to your application
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
```build.gradle.kts
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
repositories {
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
    maven {
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
        url = uri("https://jitpack.io")
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
    }
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
}
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
dependencies {
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
    implementation("com.geekorum.aboutoss:ui-material:0.0.1")
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
}
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
```
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
### Launch the license activity
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
```
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
val intent = Intent(this, OpenSourceLicensesActivity::class.java)
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
startActivity(intent)
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
```
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
Build instructions
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
==================
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
Just use Gradle to build
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
    ./gradlew build
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    49
License
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    50
=======
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    51
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    52
AboutOss is an open source library and is licensed under the GNU General Public License 3 and any later version.
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    53
This means that you can get AboutOss's code and modify it to suit your needs, as long as you publish the changes
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    54
you make for everyone to benefit from as well.
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    55
b3b2e88f441f add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    56
AboutOss is built and maintained by community volunteers.