changeset 25:f3b6bf903499

better documentation
author k0s <k0scist@gmail.com>
date Mon, 15 Feb 2010 20:46:45 -0500
parents 4d1911743e82
children ee74cf1e444b
files README.txt setup.py
diffstat 2 files changed, 19 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue Jan 19 11:19:32 2010 -0500
+++ b/README.txt	Mon Feb 15 20:46:45 2010 -0500
@@ -1,11 +1,28 @@
 montage
 =======
 
-photogallery extension to `decoupage <http://k0s.org/hg/decopage>`_.
+Photogallery extension to `decoupage <http://k0s.org/hg/decopage>`_.
+If you want to present a directory of images with decoupage, montage
+is the way to do it.
 
 montage provides an additional decopage formatter, ``/images``, that
 is used to help format an image gallery (i.e. a directory full of
 images) for display.
 
+Templates
+---------
+
 montage provides additional templates to display a gallery of images
 in various formats.
+
+ * strip.html : present images in a filmstrip like environment
+ * grid.html: present images in a table
+ * sequence.html: present images like a web comic, in sequence
+ * background.html: present images with in the body backround
+
+Templates are invoked via the /template keyword in decoupage
+configuration. The webmaster may override templates on a site or
+directory basis,
+
+Example:
+/template = strip.html
--- a/setup.py	Tue Jan 19 11:19:32 2010 -0500
+++ b/setup.py	Mon Feb 15 20:46:45 2010 -0500
@@ -1,7 +1,7 @@
 import os
 from setuptools import setup, find_packages
 
-version = '0.3'
+version = '0.3.1'
 
 try:
     description = file(os.path.join(os.path.dirname(__file__), 'README.txt')).read()