Author: gertv
Date: Mon Oct 18 07:44:06 2010
New Revision: 1023672
URL: http://svn.apache.org/viewvc?rev=1023672&view=rev
Log:
Adding a README file
Added:
servicemix/documentation/trunk/README.md
Added: servicemix/documentation/trunk/README.md
URL:
http://svn.apache.org/viewvc/servicemix/documentation/trunk/README.md?rev=1023672&view=auto
==============================================================================
--- servicemix/documentation/trunk/README.md (added)
+++ servicemix/documentation/trunk/README.md Mon Oct 18 07:44:06 2010
@@ -0,0 +1,26 @@
+## Prerequisites ##
+You need to have these two programs installed on your machine:
+
+- [Pygments] - syntax highlighting for HTML and PDF (http://pygments.org/)
+- [Prince XML] - converts HTML into PDF for the manual
(http://www.princexml.com/)
+
+## Building SNAPSHOT dependencies ##
+This project depends on a few SNAPSHOT dependencies. Before you start working
on the docs, you need to checkout and build these two projects locally:
+
+-
[http://github.com/jstrachan/maven-scala-plugin](http://github.com/jstrachan/maven-scala-plugin)
+- [http://github.com/scalate/scalate](http://github.com/scalate/scalate)
+
+## Building the documentation project ##
+There are two ways of building the documentation project:
+
+- `mvn -Plive jetty:run` will make a live website copy available
[locally](http://localhost:8080). This is very convenient while editing the
docs to quickly review the changes you made.
+- `mvn clean install` will build the documentation project, creating 3
representations:
+ - a war file containing the documentation webapp
+ - a pdf file (in `target/sitegen/manual.pdf`)
+ - a static website, generated using the same templates (in `target/sitegen`)
+
+## Known issues ##
+
+- The war file currently can't be deployed on ServiceMix
+
+
