* JDK 1.5

Note: that this is a buildtime dependency for 1.5 specific

features. However the final built jars should run on 1.4

and 1.3 JVMs with some features unavailable.

* Ant 1.6 or greater

To enable testing support, ensure junit.jar exists in

ANT_HOME/lib.

ant

For a list of finer grained build operations:

ant -projecthelp

The default version number used in the build is 'SNAPSHOT'.

To override this, you can pass a property to ant:

ant -Dversion=MY.OTHER.VERSION

--[ Building from the IDE ]----------------------------------

It is possible to compile and test the source directly from

popular IDEs, without resorting to the command line.

Steps:

- Run 'ant library'. This generates additional Java coded

necessary to compile.

- Create a new project.

- Add the following directories as source directories:

hamcrest-api/src/main/java

hamcrest-generator/src/main/java

hamcrest-core/src/main/java

hamcrest-library/src/main/java

hamcrest-integration/src/main/java

build/temp/hamcrest-core/generated-code

build/temp/hamcrest-library/generated-code

hamcrest-examples/src/main/java

- Add the following directories as test directories:

hamcrest-api/src/test/java

hamcrest-generator/src/test/java

hamcrest-core/src/test/java

hamcrest-library/src/test/java

hamcrest-integration/src/test/java

If this is unsupported by the IDE, add them as source

directories.

- Include all jars in the lib directory in the classpath.

- Compile as usual in the IDE.

- If supported, run all tests under org.hamcrest from the

IDEs JUnit runner.

Binaries

Depending on how you intend to use Hamcrest, you should use different Jars.

* __hamcrest-core.jar__ -- This is the core API to be used by third-party framework providers. This includes the a foundation set of matcher implementations for common operations. This API is stable and will rarely change. You will need this library as a minimum.

* __hamcrest-library.jar__ -- The ever-growing library of Matcher implementations. This will grow between releases.

* __hamcrest-generator.jar__ -- A tool to allow many Matcher implementations to be combined into a single class so users don't have to remember many classes/packages to import. Generates code.

* __hamcrest-integration.jar__ -- Provides integration between Hamcrest and other testing tools, including JUnit (3 and 4), TestNG, jMock and EasyMock.

Alternatively, if you don't care:

* __hamcrest-all.jar__ -- Includes all of the above.

Sources and JavaDoc jars are available for all of the above.

Documentation can be found on the [google code wiki][].

If you find an issue with Java Hamcrest, please report it via the [GitHub issue tracker][], after first checking that it hasn't been raised already. N.B. a few issues are still tracked using the old [google code Issue tracker][].

The complete source for Hamcrest is bundled. This includes:

* Matcher core classes [src/core]

* Matcher library [src/library]

* Matcher integrations [src/integration]

* Syntactic sugar generator [src/generator]

* Unit tests [src/unit-test]

* Ant build file [build.xml]

* Dependencies [lib]