blob: 7d7c453397920858df5db646b33983e8c088c665 [file] [log] [blame]
mparker8bdb1222009-05-27 22:16:16 +00001Jakarta Commons Collections
2===========================
3
4Welcome to the Collections component of the Jakarta Commons project.
5This component contains many new collections and collection utilities.
6
7Two jar files are produced by this component.
8The first, commons-collections.jar is the main jar used by applications.
9The second, commons-collections-testframework.jar is an extension to junit
10for testing new collection implementations and is not normally used by applications.
11
12
13Building from source
14--------------------
15This component requires the excellent Ant utility.
16It can be found here :
17
18 http://ant.apache.org/
19
20For testing the project, you will also need JUnit :
21
22 http://www.junit.org/
23
24To let the test process find JUnit, you may make a
25copy of the build.properties.sample file, rename to
26build.properties, and modify to reflect
27the location of the junit.jar on your computer.
28
29
30Once you have Ant properly installed, and the
31build.properties file correctly reflects the location
32of your junit.jar, you are ready to build and test.
33The major targets are:
34
35ant compile - compile the code
36ant test - test using junit
37ant jar - create a jar file
38ant javadoc - build the javadoc
39ant dist - create folders as per a distribution
40ant tf.jar - create the testframework jar file
41ant tf.javadoc - build the testframework javadoc
42
43
44Maven
45-----
46The component can also be built using Maven. (Ant is the primary build tool.)
47It can be found here :
48
49 http://maven.apache.org/
50
51Once installed, the jars may be built with 'maven jar'.