diff --git a/README.md b/README.md index cbff1bf..b4d7cae 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## What is it? -It's the barebones library project intended to quickly bootstrap a Kotlin Multiplatform library, that is deployable to Maven Central. +It's the bare-bones 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. @@ -13,9 +13,9 @@ It has only one function: generate the [Fibonacci sequence](https://en.wikipedia 1. [x] Clone this repository ot just [use it as template](https://github.com/asm0dey/dummylib-multiplatform/generate) 2. [ ] Edit project name in [`settings.gradle.kts`](settings.gradle.kts#L17) 3. [ ] 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 - 1. If you don't need an Android support delete the [`android` section](library/build.gradle.kts#L37-L43) -4. [ ] Edit [build targets you need](library/build.gradle.kts#L9-L21) + 1. If you need the Android support update namespace [there](dummylib/build.gradle.kts#L38) too + 2. If you don't need an Android support delete the [`android` section](dummylib/build.gradle.kts#L37-L43) +4. [ ] Edit [build targets you need](dummylib/build.gradle.kts#L9-L21) At this stage you given you have everything setup to work with Kotlin Multiplatform the project shoud be buildable (but you might need to provide actual starting values for platforms you need). @@ -44,7 +44,7 @@ The most part of the job is already automated for you. However, deployment to Ma gh secret set OSSRH_PASSWORD -a actions --body "" gh secret set OSSRH_GPG_SECRET_KEOSSRH_USERNAMEY_ID -a actions --body "" ``` - 2. Or via interface in `Seetings` → `Secrets and Variables` → `Actions` same variables as in 1. + 1. Or via interface in `Seetings` → `Secrets and Variables` → `Actions` same variables as in 1. 8. [ ] Edit deploy targets in [`deploy.yml`](.github/workflows/deploy.yml#L23-L36) 9. [ ] Call deployment manually when ready [in Actions](../../actions/workflows/deploy.yml) → `Run Workflow` 10. [ ] When you see in your account on https://oss.sonatype.org that everything is fine you can release your staging repositories and add target `releaseSonatypeStagingRepository` to `deploy.yml` [after this line](.github/workflows/deploy.yml#L60). This way artifacts will be published to central automatically when tests pass. diff --git a/library/build.gradle.kts b/dummylib/build.gradle.kts similarity index 100% rename from library/build.gradle.kts rename to dummylib/build.gradle.kts diff --git a/library/src/androidMain/kotlin/fibiprops.android.kt b/dummylib/src/androidMain/kotlin/fibiprops.android.kt similarity index 100% rename from library/src/androidMain/kotlin/fibiprops.android.kt rename to dummylib/src/androidMain/kotlin/fibiprops.android.kt diff --git a/library/src/androidUnitTest/kotlin/FibiTest.kt b/dummylib/src/androidUnitTest/kotlin/FibiTest.kt similarity index 100% rename from library/src/androidUnitTest/kotlin/FibiTest.kt rename to dummylib/src/androidUnitTest/kotlin/FibiTest.kt diff --git a/library/src/commonMain/kotlin/CustomFibi.kt b/dummylib/src/commonMain/kotlin/CustomFibi.kt similarity index 100% rename from library/src/commonMain/kotlin/CustomFibi.kt rename to dummylib/src/commonMain/kotlin/CustomFibi.kt diff --git a/library/src/iosMain/kotlin/fibiprops.ios.kt b/dummylib/src/iosMain/kotlin/fibiprops.ios.kt similarity index 100% rename from library/src/iosMain/kotlin/fibiprops.ios.kt rename to dummylib/src/iosMain/kotlin/fibiprops.ios.kt diff --git a/library/src/iosTest/kotlin/FibiTest.kt b/dummylib/src/iosTest/kotlin/FibiTest.kt similarity index 100% rename from library/src/iosTest/kotlin/FibiTest.kt rename to dummylib/src/iosTest/kotlin/FibiTest.kt diff --git a/library/src/jvmMain/kotlin/fibiprops.jvm.kt b/dummylib/src/jvmMain/kotlin/fibiprops.jvm.kt similarity index 100% rename from library/src/jvmMain/kotlin/fibiprops.jvm.kt rename to dummylib/src/jvmMain/kotlin/fibiprops.jvm.kt diff --git a/library/src/jvmTest/kotlin/FibiTest.kt b/dummylib/src/jvmTest/kotlin/FibiTest.kt similarity index 100% rename from library/src/jvmTest/kotlin/FibiTest.kt rename to dummylib/src/jvmTest/kotlin/FibiTest.kt diff --git a/library/src/linuxX64Main/kotlin/fibiprops.linuxX64.kt b/dummylib/src/linuxX64Main/kotlin/fibiprops.linuxX64.kt similarity index 100% rename from library/src/linuxX64Main/kotlin/fibiprops.linuxX64.kt rename to dummylib/src/linuxX64Main/kotlin/fibiprops.linuxX64.kt diff --git a/library/src/linuxX64Test/kotlin/FibiTest.kt b/dummylib/src/linuxX64Test/kotlin/FibiTest.kt similarity index 100% rename from library/src/linuxX64Test/kotlin/FibiTest.kt rename to dummylib/src/linuxX64Test/kotlin/FibiTest.kt diff --git a/settings.gradle.kts b/settings.gradle.kts index 9fcb182..6ad51ed 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -15,4 +15,4 @@ dependencyResolutionManagement { } rootProject.name = "dummylib-multiplatform" -include(":library") +include(":dummylib")