Fixes override of environment by config files

[bpgallery.git] / README

diff --git a/README b/README
index 24ebbb9c7dc9754e28fe74e6b84298f357f3481a..9a4aec8e8941bb7405bda7296582822f6bb7798e 100644 (file)
--- a/README
+++ b/README
@@ -8,8 +8,9 @@ Requirements
 ------------
 The ImageMagick tools (convert and identify)
 bash
 ------------
 The ImageMagick tools (convert and identify)
 bash

-find
-xargs
+GNU find
+GNU xargs
+sed

 
 Installation
 ------------
 
 Installation
 ------------


@@ -19,14 +20,21 @@ Usage
 -----
 bpgallery.sh /path/to/image/files
 
 -----
 bpgallery.sh /path/to/image/files
 

-To Be Done
-----------
-* A method of adding labels to the images
-* 'Templating' of the thumbnails page
-* Use of a style sheet other than the generated one
+Also, the following files, if placed in the images directory, will be used to
+generate part of the index page:
+        description.txt - a simple text file containing paragraphs to go at the
+                          beginnings of the index page
+        captions.txt - filename<tab>caption style file, it'll add a caption to
+                       the images on the index page.
+The following environment variables can also be used:
+        TITLE - the title of the gallery
+        WIDTH - the width to make the icons
+
+Example Usage:
+        TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files

 
 Author
 ------
 Brett Parker:
 
 Author
 ------
 Brett Parker:

-       e-mail: <iDunno@sommitrealweird.co.uk>
-       www:    http://www.sommitrealweird.co.uk/
+        e-mail: <iDunno@sommitrealweird.co.uk>
+        www:    http://www.sommitrealweird.co.uk/