README for examples

[shyr]

I tried to run dokkatoo example but I failed as below. I though it's difficult because dokkatoo doesn't provide readme about how to run example.

➜  dokkatoo git:(main) pwd
/Users/sungho.moon/gopath/src/github.com/adamko-dev/dokkatoo/examples/multimodule-example/dokkatoo
➜  dokkatoo git:(main) ../../../gradlew clean dokkatooGenerate
> Task :buildSrc:generateExternalPluginSpecBuilders FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':buildSrc:generateExternalPluginSpecBuilders'.
> Could not resolve all files for configuration ':buildSrc:compileClasspath'.
   > Could not find dev.adamko.dokkatoo:dokkatoo-plugin:2.1.0-SNAPSHOT.
     Searched in the following locations:
       - https://repo.maven.apache.org/maven2/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/maven-metadata.xml
       - https://repo.maven.apache.org/maven2/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/dokkatoo-plugin-2.1.0-SNAPSHOT.pom
       - https://plugins.gradle.org/m2/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/maven-metadata.xml
       - https://plugins.gradle.org/m2/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/dokkatoo-plugin-2.1.0-SNAPSHOT.pom
       - file:/Users/sungho.moon/gopath/src/github.com/adamko-dev/dokkatoo/build/test-maven-repo/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/maven-metadata.xml
       - file:/Users/sungho.moon/gopath/src/github.com/adamko-dev/dokkatoo/build/test-maven-repo/dev/adamko/dokkatoo/dokkatoo-plugin/2.1.0-SNAPSHOT/dokkatoo-plugin-2.1.0-SNAPSHOT.pom
     Required by:
         project :buildSrc

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.

BUILD FAILED in 4s
1 actionable task: 1 executed

[aSemy]

Hi, thanks for the report!

I agree that it's not clear how to run the examples. I didn't really intend them to be run independently, they're more for copy-pasting, but they should work if you first follow the instructions in CONTRIBUTING.md.

I'll update the docs to make it more clear, but I won't be able to do this for a while.

[aSemy]

Examples now has a README!

https://github.com/adamko-dev/dokkatoo/tree/v2.3.1/examples#readme

If anything could be improved, please leave another comment, or create a PR with some suggestions.