typos fixed, todo trimmed
[mkgallery.git] / README
diff --git a/README b/README
index 354dfd5ca29a3f158d934bfbf01167fb8d182e3d..61adcea22792c2091be96b9d9661624afd3d9118 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@
 
   README document for mkgallery script
 
-  Copyright (c) 2006 Eugene G. Crosser
+  Copyright (c) 2006-2009 Eugene G. Crosser
 
   This software is provided 'as-is', without any express or implied
   warranty.  In no event will the authors be held liable for any damages
 mkgallery.pl traverses directory tree starting from current directory
 downwards, and in each directory creates an index.html file with the
 list of subdirectories and the list of image files in the directory.
-Fielsystem objects starting with '.' are not processed.  For every
+Filesystem objects starting with '.' are not processed.  For every
 directory, a file ".title" is checked, and created if absent, with the
-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).
+title for this album.  Subdirectories are created with scaled down
+versions of the images, and a directory named ".html" containging
+slideshow pages (and info pages for non-javascript clients).
 
 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"
+document tree, and put there the files from the "include" subdirectory
 of this distribution.  Then, chdir to the root of your gallery and run
 "mkgallery.pl" script.  First time, you will be asked to enter titles
 for all subdirectories ("Albums"); if you wish to recreate the titles,
@@ -53,7 +53,7 @@ command-line options:
                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.
+comments into the image files (in UTF-8 encoding).
 
 "mkindex.pl" is a simple script that is completely unrelated to the
 gallery (theoretically).  If your tree starts with YYYY/DD (four
@@ -71,11 +71,10 @@ Homepage:
 http://www.average.org/mkgallery/
 
 TODO:
-- implement header and footer insertion
 - make index.html depend of .title and directory timestamps
-- rebuild htmls in .html when directory timestamp chnges (images added)
-- make links in the rss file relative
+- rebuild htmls in .html when directory timestamp changes (images added)
+- make links in the rss file work
 - try to make showwin "Extending: Element" and get rid of domelement()
-  dummy getter and getCoordinates() replacement function
+  dummy getter and getCoordinates() replacement function (?)
 
 Eugene Crosser <crosser at average dot org>