commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject cvs commit: jakarta-commons-sandbox/betwixt README.txt
Date Thu, 06 Jun 2002 21:12:02 GMT
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:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message