Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@apache.org Received: (qmail 33060 invoked from network); 6 Jun 2002 21:14:00 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 6 Jun 2002 21:14:00 -0000 Received: (qmail 6723 invoked by uid 97); 6 Jun 2002 21:13:42 -0000 Delivered-To: qmlist-jakarta-archive-commons-dev@jakarta.apache.org Received: (qmail 6381 invoked by uid 97); 6 Jun 2002 21:13:35 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 5943 invoked by uid 97); 6 Jun 2002 21:13:24 -0000 X-Antivirus: nagoya (v4198 created Apr 24 2002) Date: 6 Jun 2002 21:12:02 -0000 Message-ID: <20020606211202.27306.qmail@icarus.apache.org> From: rdonkin@apache.org To: jakarta-commons-sandbox-cvs@apache.org Subject: cvs commit: jakarta-commons-sandbox/betwixt README.txt X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N rdonkin 2002/06/06 14:12:02 Modified: betwixt README.txt Log: Updated README to reflect Mavenized build process Revision Changes Path 1.3 +24 -24 jakarta-commons-sandbox/betwixt/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/betwixt/README.txt,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- README.txt 17 May 2002 15:24:11 -0000 1.2 +++ README.txt 6 Jun 2002 21:12:02 -0000 1.3 @@ -4,40 +4,40 @@ Welcome to the Betwixt component of the Jakarta Commons project. -This component requires the excellent Ant utility. It can -be found here : +The Betwixt build process is now Mavenized! - http://jakarta.apache.org/ant/ +For those who haven't heard of Maven, it's an ant-based +unified project build processor. See -For testing the project, you will also need JUnit : + http://jakarta.apache.org/turbine/maven/ - http://www.junit.org/ +for the Maven project documentation. This means that you +now need to download and install Maven (as well as Ant +and JUnit) if you want to build Betwixt. Full details of +how this can be done can be found on the Maven site. -To let the test process find JUnit, you may make a -copy of the build.properties.sample file, rename to -build.properties, and modify to reflect -the location of the junit.jar on your computer. +Maven downloads all neccessary dependencies for you +- so you don't need to worry about that any more! -You will also need the Jakarta commons-collections.jar +Maven uses a set of standard build commands. Here's a +couple to get you started: -Once you have Ant propertly installed, and the -build.properties file correctly reflects the location -of your junit.jar, you are ready to build and test. + robert% ant -To compile and test the component : +this executes 'maven:jar' which compiles the source, +runs the unit tests and creates a jar. -$ ant test + robert% ant maven:dist-build -To build a jar : +creates a distribution (including documentation) from +the current source as well as doing everything that +the last comment did. -$ ant dist-jar +See the maven documentation for more details and +information about the other standard build commands. -To build the API documentation : - -$ ant doc - -To build the jar and API doc at once : - -$ ant dist +Note: + Maven creates the documentation in +betwixt/target/docs rather than betwixt/dist/docs. -- To unsubscribe, e-mail: For additional commands, e-mail: