1 AboutOss |
1 AboutOss |
2 ========== |
2 ========== |
3 |
3 |
4 AboutOss is an utility library to retrieve and display opensource licenses in Android applications. |
4 AboutOss is a Kotlin Multiplatform utility library to retrieve and display opensource licenses in your applications. |
5 |
5 |
6 Usage |
6 License sources |
7 ===== |
7 --------------- |
8 |
8 |
9 The library works with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/master/oss-licenses-plugin). |
9 The library can work with license information files generated by: |
10 You can integrate it in your application with few simple steps. |
|
11 |
10 |
12 ### Apply the OSS Licenses Gradle Plugin |
11 - [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/main/oss-licenses-plugin) |
|
12 - [licensee](https://github.com/cashapp/licensee) |
|
13 - [LicensePlist](https://github.com/mono0926/LicensePlist) |
13 |
14 |
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: |
15 User interface |
|
16 -------------- |
15 |
17 |
16 ```kotlin title="build.gradle.kts" |
18 The user interface to display license information is written in [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform). |
17 apply plugin: 'com.google.android.gms.oss-licenses-plugin' |
19 There is out of the box composables for Material and Material3 and you can easily write your own UI. |
18 ``` |
|
19 |
20 |
20 ### Add the ui library to your application |
21 Check the sample [here](https://github.com/fbarthelery/AboutOss/tree/main/sample) |
21 |
|
22 ```kotlin title="build.gradle.kts" |
|
23 repositories { |
|
24 maven { |
|
25 url = uri("https://jitpack.io") |
|
26 } |
|
27 } |
|
28 |
|
29 dependencies { |
|
30 implementation("com.geekorum.aboutoss:ui-material:0.0.1") |
|
31 } |
|
32 ``` |
|
33 |
|
34 ### Launch the license activity |
|
35 |
|
36 ```kotlin |
|
37 val intent = Intent(this, OpenSourceLicensesActivity::class.java) |
|
38 startActivity(intent) |
|
39 ``` |
|
40 |
22 |
41 Build instructions |
23 Build instructions |
42 ================== |
24 ================== |
43 |
25 |
44 Just use Gradle to build |
26 Just use Gradle to build |