CATARACT
Static web photo gallery generator
http://cgg.bzatek.net/

version 0.99.2 [2009-02-26]
Copyright (C) 2008-2009 Tomas Bzatek <tbzatek@users.sourceforge.net>


DESCRIPTION
-----------

This is the CGG, Cataract Gallery Generator - a simple static web photo
gallery, designed to be clean and easily usable. Due to the static design,
there's no way to comment pictures on the web.

Feature highlights:
  *  static HTML gallery, no extra requirements on server
  *  fast, easy to cache/mirror
  *  XML-based description files
  *  modern design, valid XHTML 1.0 and CSS 2
  *  EXIF & IPTC support
  *  console application, allowing easy scripting 
     (e.g. auto-refresh after new images are uploaded via FTP)

Planned features:
  *  autotoolize
  *  optional pushing comments and captions to images
  *  switchable flat album view
  *  slideshow mode
  *  switchable styles
  *  jBrout db support?
  *  stars rating system (iframed php script?)


DOCUMENTATION
-------------

CGG creates a set of HTML files and images from the source structure. 
Input files are structured in subdirectories, each directory may contain 
only one index XML file and the generated directory tree copies the source
structure. All links to sub-galleries, items, descriptions and individual 
settings are specified in XML files. No more files other than global setup 
XML file are needed.

For convenience, sources contain the cgg-dirgen.sh script, which creates 
an index XML template from images in current directory. That can be used 
as a skeleton of new album, writing down title, description and comments.

For detailed syntax of input XML files please check the sample gallery included
in the source tree. It demonstrates basic features and contains detailed tag
description inside the XML files.


BUILDING
--------

First make sure you have met the following requirements:
  libxml-2.0  (tested with 2.7.2)
  glib-2.0    (2.12.0 recommented, tested with 2.18.3)
  exiv2       (tested with 0.17.1)
  ImageMagick (tested with 6.4.5.7)

To compile cgg, type 'make'


DEVELOPMENT
-----------

gitweb: http://git.bzatek.net/?p=cataract;a=summary
repository snapshot command:
  git clone git://git.bzatek.net/cataract

For write access to the repository please contact developers.


LICENSE
-------

Please see 'COPYING'