svn commit: r744683 - /james/mime4j/trunk/BUILDING.txt

[ol...@apache.org]

Author: olegk
Date: Sun Feb 15 16:02:36 2009
New Revision: 744683

URL: http://svn.apache.org/viewvc?rev=744683&view=rev
Log:
Updated build instructions

Modified:
    james/mime4j/trunk/BUILDING.txt

Modified: james/mime4j/trunk/BUILDING.txt
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/BUILDING.txt?rev=744683&r1=744682&r2=744683&view=diff
==============================================================================
--- james/mime4j/trunk/BUILDING.txt (original)
+++ james/mime4j/trunk/BUILDING.txt Sun Feb 15 16:02:36 2009
@@ -1,8 +1,44 @@
-In order to build mime4j you need maven 2.0.6 or greater.
+Building Apache Mime4j 
+======================
 
-mvn -U -Plocal package
+(1) Requisites
+--------------
+Mime4j utilizes Maven 2 as a distribution management and packaging tool. Version 2.0.7 
+or above is recommended. 
 
--U runs a plugin update
--Plocal enable the local stage repository for dependencies.
+JDK 1.5 or above is required in order to compile Mime4j.
 
-Redistributables will be placed in the target folder. 
\ No newline at end of file
+Maven installation and configuration instructions can be found here:
+
+http://maven.apache.org/run-maven/index.html
+
+(2) Executing test cases
+
+Execute the following command in order to compile and test the components:
+
+mvn test
+
+(3) Building packages 
+
+Execute the following command in order to build JAR and assembly packages:
+
+mvn package
+
+One can also utilize the 'local' profile to build JAR and assembly packages
+in the off-line mode:
+
+mvn -Plocal package
+
+Redistributables will be placed in the target folder. 
+
+(4) Building documentation 
+
+Execute the following command in order to generate javadoc:
+
+mvn javadoc:javadoc
+
+(5) Building project web site 
+
+Execute the following command in order to generate the project web site:
+
+mvn site
\ No newline at end of file