diff --git a/README.md b/README.md index c2f2db1..8075f18 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,17 @@ ## What is it? -It's the barebones library project intended to quickly bootstrap a Kotlin Multiplatform library, that is deployable to Maven Central. +It is the barebones library project intended to quickly bootstrap a Kotlin Multiplatform library, that is deployable to Maven Central. It has only one function: generate the [Fibonacci sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence) starting from platform-provided numbers. Also, it has a test for each platform just to be sure that tests run. -*Almost all links will work correctly in your own repository* +Note that no other actions or tools usually required for the library development are set up, such as [tracking of backwards compatibility] +(https://kotlinlang.org/docs/jvm-api-guidelines-backward-compatibility.html#tools-designed-to-enforce-backward-compatibility), explicit API mode, +licensing, contribution guideline, code of conduct and others. ## How do I build it? -1. - [x] Clone this repository ot just [use it as template](https://github.com/asm0dey/dummylib-multiplatform/generate) +1. - [x] Clone this repository ot just [use it as template](https://github.com/Kotlin/multiplatform-library-template/generate) 1. - [ ] Edit library module name and include it in [`settings.gradle.kts`](settings.gradle.kts#L18) 1. - [ ] Edit [`groupId` and `version`](convention-plugins/src/main/kotlin/module.publication.gradle.kts#L10-L11) 1. If you need the Android support update namespace [there](library/build.gradle.kts#L38) too diff --git a/convention-plugins/src/main/kotlin/module.publication.gradle.kts b/convention-plugins/src/main/kotlin/module.publication.gradle.kts index 6a216c4..e18c9f1 100644 --- a/convention-plugins/src/main/kotlin/module.publication.gradle.kts +++ b/convention-plugins/src/main/kotlin/module.publication.gradle.kts @@ -18,9 +18,9 @@ publishing { // Provide artifacts information required by Maven Central pom { - name.set("Dummy Kotlin Multiplatform library") + name.set("Kotlin Multiplatform library template") description.set("Dummy library to test deployment to Maven Central") - url.set("https://github.com/asm0dey/dummylib-multiplatform") + url.set("https://github.com/Kotlin/multiplatform-library-template") licenses { license { @@ -30,13 +30,14 @@ publishing { } developers { developer { - id.set("asm0dey") - name.set("Pasha Finkelshteyn") - email.set("asm0dey@jetbrains.com") + id.set("JetBrains") + name.set("JetBrains Team") + organization.set("JetBrains") + organizationUrl.set("https://www.jetbrains.com") } } scm { - url.set("https://github.com/asm0dey/dummylib-multiplatform") + url.set("https://github.com/Kotlin/multiplatform-library-template") } } } @@ -47,4 +48,4 @@ signing { useGpgCmd() sign(publishing.publications) } -} \ No newline at end of file +} diff --git a/convention-plugins/src/main/kotlin/root.publication.gradle.kts b/convention-plugins/src/main/kotlin/root.publication.gradle.kts index 152a07c..12e295f 100644 --- a/convention-plugins/src/main/kotlin/root.publication.gradle.kts +++ b/convention-plugins/src/main/kotlin/root.publication.gradle.kts @@ -3,7 +3,7 @@ plugins { } allprojects { - group = "com.github.asm0dey.dummylib" + group = "org.jetbrains.kotlinx.multiplatform-library-template" version = "0.0.1" } diff --git a/gradle.properties b/gradle.properties index f60cfee..5e4d56d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,14 +2,11 @@ org.gradle.jvmargs=-Xmx2048M -Dfile.encoding=UTF-8 -Dkotlin.daemon.jvm.options\="-Xmx2048M" org.gradle.caching=true org.gradle.configuration-cache=true - #Kotlin kotlin.code.style=official kotlin.js.compiler=ir - #MPP kotlin.mpp.enableCInteropCommonization=true - #Android android.useAndroidX=true android.nonTransitiveRClass=true diff --git a/library/build.gradle.kts b/library/build.gradle.kts index 51d0fab..a557108 100644 --- a/library/build.gradle.kts +++ b/library/build.gradle.kts @@ -35,7 +35,7 @@ kotlin { } android { - namespace = "com.github.asm0dey.dummylib" + namespace = "org.jetbrains.kotlinx.multiplatform-library-template" compileSdk = libs.versions.android.compileSdk.get().toInt() defaultConfig { minSdk = libs.versions.android.minSdk.get().toInt() diff --git a/settings.gradle.kts b/settings.gradle.kts index 56f829e..9be41d2 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -14,5 +14,5 @@ dependencyResolutionManagement { } } -rootProject.name = "dummylib-multiplatform" +rootProject.name = "multiplatform-library-template" include(":library")