------------------------------------------------------------------------
Tint
  http://www.indii.org/software/tint/

Lawrence Murray
  lawrence@indii.org
------------------------------------------------------------------------

Tint is a photo filter for colour-select effects. It automatically clusters
the colours of a photo into distinct groups, and allows each colour to be
turned on or off to achieve the desired effect.


1. Requirements
------------------------------------------------------------------------

The library requires:

  * wxWidgets v2.8.0 <http://www.wxwidgets.org/>
  * Boost UBLAS <http://www.boost.org/>

and for compilation:

  * Scons <http://www.scons.org/>

These are commonly installed with Linux distributions or readily available
through package managers.


2. Installation
------------------------------------------------------------------------

To compile the program use:

scons

This will check for dependencies and compile all sources. To run the program
after compilation use:

./tint

For a list of build options use:

scons -h

Any of these options may be set either by editing the config.py file
or by specifying them as NAME=VALUE pairs on the command line. For
example, to build with assertions disabled either enter:

NDEBUG = 'yes'

into config.py, or use:

scons NDEBUG=yes

on the command line.

Options given at the command line override those in config.py, and
those in config.py override the defaults for your system.


3. Tips
------------------------------------------------------------------------

Tint does not yet have a complete manual or help system. Until it does, here
are a few tips to improve your results:

  * The number of colour groups that you set during the wizard indicates the
    number of clusters that Tint will attempt to find. Once the wizard has
    finished, this is the number of checkboxes which appear to allow colour to
    be turned on and off.

  * The clustering process, which is used to find colour groups, is
    stochastic. This means that you won't necessarily get the same result each
    time you run with the same photo. The "Quality" option on the second page
    of the wizard tells Tint to cluster several times, and choose what it
    considers to be the best set of colour groups to keep. The higher the
    quality, the more passes and the better the colour groups.

  * Tint usually clusters on colour alone. For some photos it can be worth
    considering the x- and/or y-coordinates as well. The best examples are
    landscape photos, where adding the y-coordinate biases Tint to separately
    cluster colours in the sky and land, sometimes achieving better results.

  * Increasing the number of colour groups and quality does come at a price --
    it will take longer to cluster the image.


4. Acknowledgements
------------------------------------------------------------------------

This program uses icons from the Nuvola icon set
<http://icon-king.com/?p=15>. See the images/nuvola/ directory for licensing
information.


5. Feedback and further information
------------------------------------------------------------------------

For further information see the website
<http://www.indii.org/software/tint/> or contact the author,
Lawrence Murray <lawrence@indii.org>.

As Tint is still essentially a prototype of an idea, please offer your
feedback as to how you think it can be better, and what features you would
like to see.

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