diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 80 |
1 files changed, 80 insertions, 0 deletions
@@ -0,0 +1,80 @@ +CATARACT +Static web photo gallery generator +http://cgg.bzatek.net/ + +version 0.99.0 [2008-07-27] +Copyright (C) 2008 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 support + * console application, allowing easy scripting + (e.g. auto-refresh after new images are uploaded via FTP) + +Planned features: + * prefetch of next image (JavaScript) + * strip unnecessary blocks from images - EXIF, thumbnails + * port to exiv2 library to get rid of that weird shutter times, IPTC support + * support adding comments and copyright notes to images + * switchable flat album view + * groups in the album - e.g. separate years, decades... + * jBrout db support? + + +DOCUMENTATION +------------- + +CGG creates a set of HTML files and images from the source structure. +Input files are structured in subdirectories, each directory may contain +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 +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 meet the following requirements: + libxml-2.0 (tested with 2.6.32) + glib-2.0 (2.12.0 recommented, tested with 2.16.3) + libexif (tested with 0.6.16) + ImageMagick (tested with 6.4.2.0) + +To compile cgg, type 'make' + + +DEVELOPMENT +----------- + +gitweb: http://git.bzatek.net/?p=tuxcmd/.git;a=summary +repository snapshot command: + git clone git://git.bzatek.net/tuxcmd + +For write access to the repository please contact developers. + + +LICENSE +------- + +Please see 'LICENSE' + |