Starts readme

README.md

@@ -0,0 +1,26 @@
+# Multiplatform library template
+
+## What is it?
+
+It's 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*
+
+## How do I build it?
+
+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#L15)
+3. [ ] Edit [`groupId` and `version`](build.gradle.kts#L9-L10)
+    1. If you need the Android support update namespace [there](build.gradle.kts#L20-L45) too
+    1. If you don't need an Android support delete the [`android` section](build.gradle.kts#L55-L66)
+4. [ ] Edit [build targets you need](build.gradle.kts#L20-L45)
+
+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).
+
+## How do I make it build on GitHub Actions?
+
+To make it work on GitHub actions you need to update the [`matrix` section in `gradle.yml`](.github/workflows/gradle.yml#L25-L34). If you didn't change platforms in `build.gradle.kts` you don't need to touch anything. But still read it to understand how it works.
+
+Also, currently it only runs tests, but you can change this behavior as you wish by modifying `matrix` and the Gradle [build command](.github/workflows/gradle.yml#L52)