update README

README

@@ -1,31 +1,37 @@
 sigal - yet another simple static gallery generator
 ===================================================
 
-sigal is yet another python script to prepare a static gallery of images:
+sigal is yet another python script to build a static gallery of images:
 
-* resize images, create thumbnails with some options (squared thumbs, ...).
-* generate html pages using jinja2 templates.
+* process directories recursively,
+* resize images and create thumbnails,
+* generate html pages using jinja2 templates and with relative links for a portable output.
 
 Dependencies
 ------------
 
 - Python Imaging Library (PIL)
 - Jinja2
-- exiv2 (optionnal, used to copy exif metadatas)
+- pyexiv2 (optionnal, used to copy exif metadatas)
 
 Usage
 -----
 
-    $ sigal [options] input_dir output_dir
+    $ sigal [-h] [--version] [-c COPYRIGHT] [-f] input_dir output_dir
+
+### required arguments
+
+    input_dir	      input directory
+    output_dir	      output directory
+
+### optional arguments
 
-Options:
-    --version             show program's version number and exit
     -h, --help            show this help message and exit
-    -c COPYRIGHT, --copyright=COPYRIGHT
+    --version             show program's version number and exit
+    -c COPYRIGHT, --copyright COPYRIGHT
                           copyright message added to the images
-    -f FORCE, --force=FORCE
-                          force the reprocessing of existing images and
-                          thumbnails
+    -f, --force           force the reprocessing of existing images and
+                        thumbnails
 
 Settings
 --------
@@ -33,6 +39,8 @@ Settings
 Options can be set globally in `~/.config/sigal/sigal.conf` and in the source
 directory `input_dir/sigal.conf`.
 
+* theme:
+	theme = default
 * size of resized image:
 	img_size = 640x480
 * prefix for thumbnails name:
@@ -55,3 +63,17 @@ directory `input_dir/sigal.conf`.
 Album information
 -----------------
 
+Information on an album can be given in a file named `album_description` (else
+the directory's name is used) :
+
+	album_name = "An example gallery"
+        album_description = "And a cool description."
+        album_representative = "test1.jpg"
+
+Credits
+-------
+
+sigal use or is inspired from some code from other projects:
+* galleria: http://galleria.aino.se/
+* WordPress Photography Theme: http://thethemefoundry.com/photography/
+* lazygal: http://sousmonlit.dyndns.org/~niol/playa/oss/projects/lazygal/

test/sigal.conf

@@ -1,5 +1,7 @@
 [sigal]
 
+# theme
+theme = default
 # size of resized image
 img_size = 640x480
 # prefix for thumbnails name