neat footer

[mkgallery.git] / README

diff --git a/README b/README
index b6cb4ccdc343dbc74c6fcfc1b8f714f9c4f91112..354dfd5ca29a3f158d934bfbf01167fb8d182e3d 100644 (file)
--- a/README
+++ b/README
@@ -29,7 +29,7 @@ title for this album.  Two subdirectories are created with scaled down
 versions of the images: ".640" and ".160", and a direcotory named ".html"
 containging slideshow pages (and info pages for non-javascript clients).
 
-For the thing to work, you must create a subdirectory named ".include"
+For the thing to work, you must create a subdirectory named ".gallery2"
 at the root of your image gallery, or somewhere upstairs in the
 document tree, and put there files from the subdirectory "include"
 of this distribution.  Then, chdir to the root of your gallery and run
@@ -41,12 +41,16 @@ there.  This way you can preserve index created by hand or by some other
 script like "mkindex.pl".
 
 command-line options:
- --incpath:     do not try to fine .include diretory upstream, use
+ --help:       print help message and exit
+ --incpath:    do not try to find .gallery2 diretory upstream, use
                specified path (absolute or relavive).  Use with causion.
  --debug:      print a lot of debugging info to stdout as you run
  --asktitle:   ask to edit album titles even if there are ".title" files
  --noasktitle: don't ask to enter album titles even where ".title"
                files are absent.  Use partial directory names as titles.
+ --rssfile:    partial name of rss file. Must be reachable from the
+               current directory or from one of upper directories.
+               First must be created with mkgalrss.pl script.
 
 The only way to specify titles for individual pictures is to write
 comments into the image files.
@@ -61,12 +65,17 @@ Requirements:
 Image::Info
 Image::Magick (optional. If not present, will run djeg|pnmscale|cjpeg pipe)
 Term::ReadLine
+XML::RSS (optional. If not present, will refuse to make RSS feed)
 
 Homepage:
 http://www.average.org/mkgallery/
 
 TODO:
+- implement header and footer insertion
 - make index.html depend of .title and directory timestamps
-- any ideas?
+- rebuild htmls in .html when directory timestamp chnges (images added)
+- make links in the rss file relative
+- try to make showwin "Extending: Element" and get rid of domelement()
+  dummy getter and getCoordinates() replacement function
 
 Eugene Crosser <crosser at average dot org>