Agave
=================

Agave is a program for generating colorschemes from a starting color.  It
currently supports five different colorscheme types:
 * Complements: The starting color and the color directly across the color wheel
 * Split Complements: the starting color and the two colors that are slightly
   offset from the color directly across the color wheel
 * Triads: the starting color and the two colors 1/3 of the way around the wheel
   in each direction.
 * Tetrads: The starting color and its complement plus another color slightly
   offset from the starting color and _its_ complement
 * Analogous: The starting color and two colors slightly offset in hue
 * Monochromatic: The starting color and two other colors of the same hue, one
   lighter, and one darker


Installation
------------
For installation instructions, see the file named INSTALL in the root of the
tarball source tree. You will need at least Gtkmm 2.6.x and boost::shared_ptr
installed to build from a released tarball.  If you want to build from the
source repository, you'll also need gnome-common, and the GNU autotools
installed.

In addition to these dependencies, there are optional dependencies on libgnome,
libgnomeui, and gconfmm.  These libraries are required by default, but if you
want to build without them, run configure like so:

    $ ./configure --disable-gconf --disable-gnome

If you want to run the unit tests (very unlikely, and they're probably out of
date anyway), you'll need to have cppunit installed.

From a base Ubuntu Linux installation, you can get everything you need by
installing the following packages (be aware that these packages will install a
lot of their own dependencies as well, so you'll end up installing approximately
50 packages):
    - make
    - automake1.7
    - autoconf
    - g++
    - gnome-common
    - libgtkmm-2.4-dev
    - libboost-dev
    - libgnomeui-dev
    - libgconfmm-2.6-dev
    - libcppunit-dev

For other Linux distributions, the package names will probably be slightly
different, but the list should be fairly similar.


Installation on Windows
-----------------------
I have successfully compiled and run Agave on Microsoft Windows, though it's not
as straightforward as it is on Linux.  You'll obviously need to have the
development package of gtkmm installed (see [1] for a windows installer of
gtkmm).  

Compiling gtkmm applications on Windows requires the MinGW [2] compiler (the
cygwin g++ compiler won't work).  You'll also need the autotools installed (i.e.
autoconf and automake).  The easiest way to do this is to install these via
cygwin [3]. 

Within the cygwin environment, installation is basically the same as under
Linux (see above), but you'll need to disable support for gconf and GNOME.  The
only problem is that it will default to using cygwin paths (i.e.  /usr/local)
instead of standard windows paths (i.e. c:\Program Files\).  When the program is
run outside the cygwin environment, it won't know how to access /usr/local, so
the program will crash.  To get around this problem, you'll need to explicitly
specify the datadir (the directory where icons and other data files get
installed) when you run configure.  For example:

    $ ./configure --disable-gconf --disable-gnome --datadir="C:\path\to\datadir"

This will end up installing the actual executable agave.exe into
/usr/local/bin/ (which translates to something like c:\cygwin\usr\local\bin\
outside of cygwin).  If you want to install it somewhere else, you'll need to
specify an alternate installation directory by adding a prefix option to your
configure command (e.g. --prefix="c:\Program Files").

[1] http://www.pcpm.ucl.ac.be/~gustin/win32_ports/ 
[2] http://www.mingw.org
[3] http://www.cygwin.com/


Using Agave
-----------
Choose a starting color by clicking on the color button or selecting a color
from the palette, and then select a scheme type from the combo box.  The
generated scheme will be displayed in the main window. 
The left-most Color in the main window is the currently-selected color.  This
color can be added to your favorites list with the '+' button in the bottom
right, or with the keyboard shortcut 'Ctrl+D'.
To make one of the other colors in the scheme the currently-selected color, you
can double-click the colorswatch.
To copy a hexstring representation of the color (e.g. #FFFFFF) to the
clipboard, right-click the colorswatch and select the 'copy' menu item.


Disclaimer
----------
I make no guarantee that the colorschemes generated with this program will not
suck.  If they do suck, feel free to let me know about it.  

Jonathon Jongsma <jonathon.jongsma@gmail.com>
