   ___                                    ____  _           _ _            
  |_ _|_ __ ___   __ _  __ _  ___   _ _  / ___|(_)_ __ ___ (_) | __ _ _ __ 
   | || '_ ` _ \ / _` |/ _` |/ _ \ (_|_) \___ \| | '_ ` _ \| | |/ _` | '__|
   | || | | | | | (_| | (_| |  __/  _ _   ___) | | | | | | | | | (_| | |   
  |___|_| |_| |_|\__,_|\__, |\___| (_|_) |____/|_|_| |_| |_|_|_|\__,_|_|   
                       |___/                                               


This is the README for Image::Similar version 0.02.

Image::Similar is a "module" for the Perl computer programming language, a
library of computer code to install on a computer.  This document contains four
sections:

1. About - what the module does

2. Documentation - how to learn more about the module

3. Installation - how to install this module on a computer

4. Help - what to do if you get stuck

-----------------------------------------------------------------------------

1. ABOUT

Image::Similar - find out how similar two images are

This is an experimental module for comparing images. It uses a
simplified form of the algorithm described in "An image signature
for any kind of image" to calculate image signatures and distances
between images.

The module does not contain its own image-reading facility, so images
must be loaded to the module via one of the following supported Perl
modules:





All image types are supported.



Image::Similar currently supports GRAY, GRAY_ALPHA, RGB, and RGBA
"Image::PNG::Libpng" image types, but not paletted image types. It
only supports bit depths of eight.



Use "load_image" to load the image.

-----------------------------------------------------------------------------

2. DOCUMENTATION

You can read the documentation for the module online at the following websites:

    * http://search.cpan.org/perldoc?Image::Similar
    * http://metacpan.org/release/Image-Similar

(These links go to the latest version of the module.)

After installing the module, you can read the documentation on your computer
using

    perldoc Image::Similar

-----------------------------------------------------------------------------

3. INSTALLATION

This module requires Perl version 5.6.1 or later.

To install the module from CPAN, use

    cpan Image::Similar

If you have the App::cpanminus installer, you may prefer

    cpanm Image::Similar

To install the module from the source file, Image-Similar-0.02.tar.gz, follow
this sequence of commands:

    tar xfz Image-Similar-0.02.tar.gz
    cd Image-Similar-0.02
    perl Makefile.PL
    make
    make install

If you want to test the module before installing it, use "make test" after
"make" and before "make install".

-----------------------------------------------------------------------------

4. HELP

To get help with the module, you can email the author, Ben Bullock, at
<bkb@cpan.org>. If you think there is a problem in the module, you can report a
bug at 

<https://github.com/benkasminbullock/image-similar/issues>,

or if you want to alter the source code of Image::Similar, try the public
repository on github at 

<https://github.com/benkasminbullock/image-similar>. 

-----------------------------------------------------------------------------

This README was written on Sat Feb 20 14:51:43 2016.

-----------------------------------------------------------------------------
