diff options
Diffstat (limited to 'dokka-runners/dokkatoo/examples/README.md')
| -rw-r--r-- | dokka-runners/dokkatoo/examples/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
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. |