aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
-rw-r--r--build.xml11
2 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 950f6493..7722b8ca 100644
--- a/README.md
+++ b/README.md
@@ -85,3 +85,24 @@ KDoc is a flavour of markdown with symbol processing extensions.
* $name - link to `name` (Kotlin string interpolation style), or ${java.lang.String} for longer references
* $name: - named section, optionally bound to symbol `name`, e.g. param doc
* ${code reference} -- include content of a symbol denoted by reference, e.g. code example
+
+### Building
+
+Build only dokka
+
+```bash
+ant fatjar
+```
+
+Build dokka and maven plugin
+
+```bash
+ant install-fj
+cd maven-plugin
+mvn install
+```
+
+Build dokka and install maven plugin (do not require maven installed)
+```bash
+ant build-and-install
+```
diff --git a/build.xml b/build.xml
index f8d81fc9..4174195e 100644
--- a/build.xml
+++ b/build.xml
@@ -4,6 +4,11 @@
<property name="kotlinc.repeat" value="1"/>
+ <target name="clean">
+ <delete dir="out" />
+ <delete dir="maven-plugin/target" />
+ </target>
+
<target name="build">
<mkdir dir="out"/>
@@ -46,4 +51,10 @@
<localrepository path="out/repo" />
</install>
</target>
+
+ <target name="build-and-install" depends="install-fj">
+ <mvn mavenversion="3.0.5" dir="maven-plugin" pom="maven-plugin/pom.xml">
+ <arg value="install" />
+ </mvn>
+ </target>
</project>