* Update README for release

[bpgallery.git] / README

diff --git a/README b/README
index df7e5843ffff94971984f470c4572116c5fcd362..02b2a1890163d6cfd284d81800f517000d585a86 100644 (file)
--- a/README
+++ b/README
@@ -29,6 +29,12 @@ generate part of the index page:
             filename<tab>caption style file, it'll add a caption to the images
             on the index page.
 
             filename<tab>caption style file, it'll add a caption to the images
             on the index page.
 

+If both width and height are specified then it'll be resized to the bounding
+box that contains it.
+
+If height is specified without width then the bounding box will be 100xHEIGHT
+for icons and 400xMEDIUMHEIGHT for the medium sized image pages
+

 The following environment variables can also be used:
         TITLE
             the title of the gallery
 The following environment variables can also be used:
         TITLE
             the title of the gallery


@@ -36,9 +42,15 @@ The following environment variables can also be used:
         WIDTH
             the width to make the icons
 
         WIDTH
             the width to make the icons
 

+        HEIGHT
+            the height to make the icons
+

         MEDIUMWIDTH
             set the width of images in the medium size pages
 
         MEDIUMWIDTH
             set the width of images in the medium size pages
 

+        MEDIUMHEIGHT
+            the height to make images in the medium size pages
+

         BPGALLERY_THEME
             set the theme to use (described below)
 
         BPGALLERY_THEME
             set the theme to use (described below)