Contribute Dokkatoo (#3188)

1 files changed, 29 insertions, 0 deletions

diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md
new file mode 100644
index 00000000..9b8a85e6
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md
@@ -0,0 +1,29 @@
+# Dokka Multiplatform example
+
+This example demonstrates Dokka's configuration and output for a simple 
+[Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project.
+
+It contains [Kotlin source sets](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets) for different
+platforms that are automatically picked up by Dokka from the Kotlin Gradle Plugin, and an additional custom source
+set known to Dokka only.
+
+The example demonstrates the following things:
+
+* Documentation for common code
+* Documentation for expect/actual declarations available via tabs
+* Documentation for platform-specific declarations, including functions from different source sets, but 
+  with clashing names
+* Use of Platform-specific API, such as `CPointer` from `kotlinx.cinterop`
+
+You can see up-to-date documentation generated for this example on
+[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-multiplatform-example/html/index.html).
+
+![screenshot demonstration of output](demo.png)
+
+### Running
+
+Run `dokkaHtml` task in order to generate documentation for this example:
+
+```bash
+./gradlew dokkaHtml
+```