README.txt

ImgLib2 is a general-purpose, multidimensional image processing library.

It provides an interface-driven design that supports numeric and
non-numeric data types (8-bit unsigned integer, 32-bit floating point,
etc.) in an extensible way. It implements several data sources and
sample organizations, including one single primitive array, one array
per plane, N-dimensional array "cells" cached to and from disk on
demand, and planes read on demand from disk.

ImgLib1 is the previous incarnation of the library. We encourage
developers to use ImgLib2 instead, and migrate existing ImgLib1 programs
to ImgLib2 whenever possible.


== APPLICATIONS ==

ImgLib2 is the core data model for ImageJ2; see:
    http://developer.imagej.net/imglib

Both ImgLib1 and ImgLib2 are bundled with the Fiji image processing
package:
    http://fiji.sc/

ImgLib2 is a key component of the SciJava software initiative:
    http://scijava.github.com/


== RESOURCES ==

The source code for both ImgLib1 and ImgLib2 can be found on GitHub:
    https://github.com/imagej/imglib

For documentation on how to use ImgLib2, see:
    http://fiji.sc/wiki/index.php/ImgLib2

Online Javadoc for both ImgLib1 and ImgLib2 can be found at:
    http://jenkins.imagej.net/job/ImgLib-daily/javadoc/

There are some benchmarks comparing the performance of ImgLib2 with
raw arrays, ImageJ 1.x and Dimiter Prodanov's PixLib library:
    http://developer.imagej.net/imglib-benchmarks


== BUILDING THE SOURCE CODE ==

You can build the source from the command line using Maven:
    mvn

You can also import the source into Eclipse using the m2e plugin.
Download Eclipse IDE for Java Developers (3.7 Indigo or later), which
comes with m2e preinstalled. Then run:
    File > Import > Existing Maven Projects

Select the toplevel folder of your ImgLib working copy, and Eclipse will
find all the ImgLib projects.

Both NetBeans and IntelliJ IDEA also have built-in support for Maven
projects.