Author: rdonkin
Date: Sun Apr 24 10:51:53 2011
New Revision: 1096304
URL: http://svn.apache.org/viewvc?rev=1096304&view=rev
Log:
Update Maven version and tighten prose
Modified:
james/mime4j/trunk/BUILDING.txt
Modified: james/mime4j/trunk/BUILDING.txt
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/BUILDING.txt?rev=1096304&r1=1096303&r2=1096304&view=diff
==============================================================================
--- james/mime4j/trunk/BUILDING.txt (original)
+++ james/mime4j/trunk/BUILDING.txt Sun Apr 24 10:51:53 2011
@@ -1,39 +1,23 @@
Building Apache Mime4j
======================
-(1) Requisites
---------------
-Mime4j utilizes Maven 2 as a distribution management and packaging tool.
Version 2.2.1
-or above is recommended.
+Requisites
+----------
-JDK 1.5 or above is required in order to compile Mime4j.
+* Build with Maven 3 (http://maven.apache.org)
+* Compile with JDK 1.5 or above
-Maven installation and configuration instructions can be found here:
+Quickstart
+----------
-http://maven.apache.org/run-maven/index.html
+* To execute tests
+ mvn test
-(2) Executing test cases
+* To build and package (into target directory)
+ mvn package
-Execute the following command in order to compile and test the components:
+* To generate documentation
+ mvn javadoc:javadoc
-mvn test
-
-(3) Building packages
-
-Execute the following command in order to build JAR and assembly packages:
-
-mvn 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
+* To build web site
+ mvn site
