# HG changeset patch # User Da Risk # Date 1681433808 14400 # Node ID b3b2e88f441fd3723df8f5bf6d313eb633db192e # Parent 67743d62eda91091d101aa32f587564a84fdd54a add README.md and maven publications diff -r 67743d62eda9 -r b3b2e88f441f README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Thu Apr 13 20:56:48 2023 -0400 @@ -0,0 +1,56 @@ +AboutOss +========== + +AboutOss is an utility library to retrieve and display opensource licenses in Android applications. + +Usage +===== + +The library works with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/master/oss-licenses-plugin). +You can integrate it in your application with few simple steps. + +### Apply the OSS Licenses Gradle Plugin + +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: + +```build.gradle.kts +apply plugin: 'com.google.android.gms.oss-licenses-plugin' +``` + +### Add the ui library to your application + +```build.gradle.kts +repositories { + maven { + url = uri("https://jitpack.io") + } +} + +dependencies { + implementation("com.geekorum.aboutoss:ui-material:0.0.1") +} +``` + +### Launch the license activity + +``` +val intent = Intent(this, OpenSourceLicensesActivity::class.java) +startActivity(intent) +``` + +Build instructions +================== + +Just use Gradle to build + + ./gradlew build + + +License +======= + +AboutOss is an open source library and is licensed under the GNU General Public License 3 and any later version. +This means that you can get AboutOss's code and modify it to suit your needs, as long as you publish the changes +you make for everyone to benefit from as well. + +AboutOss is built and maintained by community volunteers. diff -r 67743d62eda9 -r b3b2e88f441f core/build.gradle.kts --- a/core/build.gradle.kts Thu Apr 13 19:37:27 2023 -0400 +++ b/core/build.gradle.kts Thu Apr 13 20:56:48 2023 -0400 @@ -1,11 +1,13 @@ plugins { -// alias(libs.plugins.com.android.application) -// alias(libs.plugins.org.jetbrains.kotlin.android) id("com.android.library") kotlin("android") id("com.geekorum.build.source-license-checker") + `maven-publish` } +group = "com.geekorum.aboutoss" +version = "0.0.1" + android { namespace = "com.geekorum.aboutoss.core" compileSdk = 33 @@ -15,6 +17,9 @@ testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" consumerProguardFiles("consumer-rules.pro") + aarMetadata { + minCompileSdk = 24 + } } buildTypes { @@ -33,6 +38,13 @@ kotlinOptions { jvmTarget = "1.8" } + + publishing { + singleVariant("release") { + withJavadocJar() + withSourcesJar() + } + } } dependencies { @@ -42,4 +54,29 @@ testImplementation(libs.junit) androidTestImplementation(libs.androidx.test.ext.junit) androidTestImplementation(libs.espresso.core) -} \ No newline at end of file +} + +publishing { + publications { + val pomConfiguration: (MavenPom).() -> Unit = { + name.set("core") + description.set("A library to retrieve and display opensource licenses in Android applications") + licenses { + license { + name.set("GPL-3.0-or-later") + url.set("https://www.gnu.org/licenses/gpl-3.0.html") + distribution.set("repo") + } + } + inceptionYear.set("2023") + } + + register("release") { + afterEvaluate { + from(components["release"]) + } + artifactId = "core" + pom(pomConfiguration) + } + } +} diff -r 67743d62eda9 -r b3b2e88f441f ui/common/build.gradle.kts --- a/ui/common/build.gradle.kts Thu Apr 13 19:37:27 2023 -0400 +++ b/ui/common/build.gradle.kts Thu Apr 13 20:56:48 2023 -0400 @@ -2,8 +2,12 @@ id("com.android.library") kotlin("android") id("com.geekorum.build.source-license-checker") + `maven-publish` } +group = "com.geekorum.aboutoss" +version = "0.0.1" + android { namespace = "com.geekorum.aboutoss.ui.common" compileSdk = 33 @@ -13,6 +17,11 @@ testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" consumerProguardFiles("consumer-rules.pro") + + aarMetadata { + minCompileSdk = 24 + } + } buildTypes { @@ -31,6 +40,13 @@ kotlinOptions { jvmTarget = "1.8" } + + publishing { + singleVariant("release") { + withJavadocJar() + withSourcesJar() + } + } } dependencies { @@ -43,8 +59,32 @@ exclude("com.google.dagger", "dagger-platform") } - testImplementation(libs.junit) androidTestImplementation(libs.androidx.test.ext.junit) androidTestImplementation(libs.espresso.core) -} \ No newline at end of file +} + +publishing { + publications { + val pomConfiguration: (MavenPom).() -> Unit = { + name.set("ui-common") + description.set("A library to retrieve and display opensource licenses in Android applications") + licenses { + license { + name.set("GPL-3.0-or-later") + url.set("https://www.gnu.org/licenses/gpl-3.0.html") + distribution.set("repo") + } + } + inceptionYear.set("2023") + } + + register("release") { + afterEvaluate { + from(components["release"]) + } + artifactId = "ui-common" + pom(pomConfiguration) + } + } +} diff -r 67743d62eda9 -r b3b2e88f441f ui/material2/build.gradle.kts --- a/ui/material2/build.gradle.kts Thu Apr 13 19:37:27 2023 -0400 +++ b/ui/material2/build.gradle.kts Thu Apr 13 20:56:48 2023 -0400 @@ -2,8 +2,12 @@ id("com.android.library") kotlin("android") id("com.geekorum.build.source-license-checker") + `maven-publish` } +group = "com.geekorum.aboutoss" +version = "0.0.1" + android { namespace = "com.geekorum.aboutoss.ui.material" compileSdk = 33 @@ -13,6 +17,10 @@ testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" consumerProguardFiles("consumer-rules.pro") + + aarMetadata { + minCompileSdk = 24 + } } buildTypes { @@ -39,6 +47,13 @@ composeOptions { kotlinCompilerExtensionVersion = libs.versions.androidx.compose.compiler.get() } + + publishing { + singleVariant("release") { + withJavadocJar() + withSourcesJar() + } + } } dependencies { @@ -51,4 +66,29 @@ testImplementation(libs.junit) androidTestImplementation(libs.androidx.test.ext.junit) androidTestImplementation(libs.espresso.core) -} \ No newline at end of file +} + +publishing { + publications { + val pomConfiguration: (MavenPom).() -> Unit = { + name.set("ui-material") + description.set("A library to retrieve and display opensource licenses in Android applications") + licenses { + license { + name.set("GPL-3.0-or-later") + url.set("https://www.gnu.org/licenses/gpl-3.0.html") + distribution.set("repo") + } + } + inceptionYear.set("2023") + } + + register("release") { + afterEvaluate { + from(components["release"]) + } + artifactId = "ui-material" + pom(pomConfiguration) + } + } +}