summaryrefslogtreecommitdiff
path: root/java
diff options
context:
space:
mode:
Diffstat (limited to 'java')
-rw-r--r--java/README.mkd47
1 files changed, 47 insertions, 0 deletions
diff --git a/java/README.mkd b/java/README.mkd
index 79065f1..35f9446 100644
--- a/java/README.mkd
+++ b/java/README.mkd
@@ -6,7 +6,54 @@ Installation
mvn package
+Documentation
+-------------
+Luigi Template uses the [maven-javadoc-plugin][] to generate API
+documentation.
+
+To generate API documentation in `target/apidocs/`:
+
+ mvn javadoc:javadoc
+
+To generate API documentation as a `jar` file:
+
+ mvn javadoc:jar
+
+See [this page][maven-javadoc-plugin-usage] for additional options.
+
Tests
-----
mvn test
+
+Author
+------
+Paul Duncan ([pabs@pablotron.org][me])<br/>
+https://pablotron.org/
+
+License
+-------
+Copyright 2010-2018 Paul Duncan ([pabs@pablotron.org][me])
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[me]: mailto:pabs@pablotron.org
+[maven-javadoc-plugin]: https://maven.apache.org/plugins/maven-javadoc-plugin/
+[maven-javadoc-plugin-usage]: https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html