svn commit: r1066528 - /incubator/opennlp/site/trunk/content/opennlp/building.mdtext

[jo...@apache.org]

Author: joern
Date: Wed Feb  2 16:58:37 2011
New Revision: 1066528

URL: http://svn.apache.org/viewvc?rev=1066528&view=rev
Log:
OPENNLP-50 Wrote down the build instructions.

Added:
    incubator/opennlp/site/trunk/content/opennlp/building.mdtext

Added: incubator/opennlp/site/trunk/content/opennlp/building.mdtext
URL: http://svn.apache.org/viewvc/incubator/opennlp/site/trunk/content/opennlp/building.mdtext?rev=1066528&view=auto
==============================================================================
--- incubator/opennlp/site/trunk/content/opennlp/building.mdtext (added)
+++ incubator/opennlp/site/trunk/content/opennlp/building.mdtext Wed Feb  2 16:58:37 2011
@@ -0,0 +1,29 @@
+Title: Building from Source
+
+OpenNLP can either be build from the distributed sources or from
+a subversion checkout. These build instructions document how
+to build from the latest trunk version. The distributed source package
+include a README file which explains how to build it.
+
+To build at least Maven 3.0 and JDK 5 are required.
+If they are not installed, install them.
+
+On the first checkout everything should be build.
+Go to the opennlp folder and type "mvn install" to build all modules.
+The build installs the maven artifacts in the local repository
+and creates a binary and source distribution inside the 
+opennlp-distr/target folder.
+
+After the initial build the individual modules can be build on its own
+with "mvn install". In the opennlp-docs project it is
+recommended to always build with "mvn clean install" because
+changed docbook xml files might not be re-processed otherwise.
+
+In some cases it might be convenient to skip the tests.
+That can be done with the "-Dmaven.test.skip=true" option.
+For example type: "mvn clean install -Dmaventest.skip=true".
+No tests will no be executed.
+
+It might happen from time to time that the build fails,
+if so please report a broken build on the opennlp-dev mailing
+list. The build should always work for everyone.