From bc335de41876acd8720dce1030a79b3a7b39c3b1 Mon Sep 17 00:00:00 2001
From: Maros Marsalek <mmarsale@cisco.com>
Date: Wed, 21 Sep 2016 13:51:57 +0200
Subject: HONEYCOMB-209 Configure maven site

To produce site for Honeycomb +
javadoc
asciidoc

To build the site:
mvn clean install site:attach-descriptor site
mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage

Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
---
 tools/archetype/asciidoc/Readme.adoc | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 tools/archetype/asciidoc/Readme.adoc

(limited to 'tools/archetype/asciidoc/Readme.adoc')

diff --git a/tools/archetype/asciidoc/Readme.adoc b/tools/archetype/asciidoc/Readme.adoc
new file mode 100644
index 000000000..e5528d7ee
--- /dev/null
+++ b/tools/archetype/asciidoc/Readme.adoc
@@ -0,0 +1,13 @@
+Honeycomb Plugin Archetype
+
+    This is archetype for creating plugins for Honeycomb platform
+
+How to use it :
+
+    archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion=1.16.12-SNAPSHOT
+
+This will generate main aggregator project containing two sub-projects
+
+    -api  - project that should contain yang model files for restconf/netconf DTO classes
+    -impl - implementation project that should contain plugin translation code + wiring
+
-- 
cgit 1.2.3-korg

