added some docs on how to deploy the API docs

2012-03-08 12:24:31 +00:00
parent 366f69b8b1
commit 8d48e3c8a8
1 changed files with 23 additions and 0 deletions
@@ -0,0 +1,23 @@
+# Developer Notes
+
+## Regenerating the website
+
+To rebuild and generate the API docs, from a local checkout
+
+    cd libraries
+    mvn install
+
+Now to be able to update the website you will need to add this to your **~/.m2/settings.xml**
+
+````xml
+<server>
+   <id>github-project-site</id>
+   <username>git</username>
+</server>
+````
+
+Now you can deploy the website via:
+
+    cd website
+    mvn site:deploy
+