Getting Started

This document describes how to build the Converter library from sources and how to start using it in an application.

Getting and building the sources

To build the Converter library from sources you first need to either download a source release or checkout the latest sources from GitHub.

Once you have the sources, you can build them using the Maven build system. Executing the following command in the base directory will build the sources and install the resulting artifacts in your local Maven repository.

mvn install

See the Maven documentation for more information about the available build options.

Note that you need Java 7 or higher to build the Converter library.

Build artifacts

The Converter library build consists of a number of components and produces the following main binaries:

• target/converter-*.jar
  The Converter library. Contains the core interfaces and classes of the Converter library, but none of the the third party dependencies.
• target/converter-*-jar-with-dependencies.jar
  The Converter library and all the dependencies. Contains the core interfaces and classes of the Converter library and all the third party dependencies.

Binaries

The Converter library binaries can also be found here.