* Update changelog

[bpgallery.git] / README

diff --git a/README b/README
index 0678ce978882b51100af845a3dfdc6eee5615ed3..df7e5843ffff94971984f470c4572116c5fcd362 100644 (file)
--- a/README
+++ b/README
@@ -57,6 +57,20 @@ The following environment variables can also be used:
         INDEXDOCUMENT
             name of the index page (e.g. index.html)
 
+        PAGESDIRECTORY
+            name of the directory in which to put the pages for fullsized and
+            mediumsized images. Defaults to the image directory. This is
+            relative to the images directory, so, for example,
+            PAGESDIRECTORY=pages would create /path/to/image/files/pages
+
+        MEDIUMDIRECTORY
+            directory to generate medium sized images in, defaults to medium,
+            works the same as the PAGESDIRECTORY variable
+
+        ICONSDIRECTORY
+            directory to generate thumbnails in, defaults to icons, works the
+            same as MEDIUMDIRECTORY and PAGESDIRECTORY
+
 Example Usage:
         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
 
@@ -65,6 +79,13 @@ Themes
 Theme support is very rudimentary, basically you create functions for each of
 the parts of the template, and put them in a file named the same as the theme.
 The functions that you need to declare are as follows:
+
+        Available in all templates:
+            ${BASEURL}
+                Base directory (will generate ../ when making pages in a
+                subdirectory for getting to the generated stylesheet or to the
+                index page)
+
         bpgallery_ThemeName_head()
                 what's it for?:
                         This sets up the header for the page, generally