From 35d15601f2d129a7d3db67dd9e2f4c41c87ef083 Mon Sep 17 00:00:00 2001
From: Adam <897017+aSemy@users.noreply.github.com>
Date: Fri, 20 Oct 2023 00:39:12 +1300
Subject: Contribute Dokkatoo (#3188)

---
 dokka-runners/dokkatoo/examples/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 dokka-runners/dokkatoo/examples/README.md

(limited to 'dokka-runners/dokkatoo/examples/README.md')

diff --git a/dokka-runners/dokkatoo/examples/README.md b/dokka-runners/dokkatoo/examples/README.md
new file mode 100644
index 00000000..f39abb5b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/README.md
@@ -0,0 +1,18 @@
+# Dokkatoo Examples
+
+Examples of how to use Dokkatoo.
+
+The examples are copied from the Dokka project.
+
+### Set up
+
+The Dokka examples are synced automatically from the Dokka source code.
+
+### Tests
+
+The projects are tested in the
+[`:modules:dokkatoo-plugin-integration-tests`](./../modules/dokkatoo-plugin-integration-tests/)
+project.
+
+The Dokka Publications generated by the Dokka examples are compared against the Dokka 
+Publications generated by the Dokkatoo projects.
-- 
cgit