release 1.01

[mkgallery.git] / README

diff --git a/README b/README
index d4d71cffec5df2546c629814c3b0b59ef641c3b6..7f8b7ed9b0c47552e684474e2d9b3fc1224fd0fb 100644 (file)
--- a/README
+++ b/README
@@ -21,47 +21,53 @@
   3. This notice may not be removed or altered from any source distribution.
 
 mkgallery.pl traverses directory tree starting from current directory
   3. This notice may not be removed or altered from any source distribution.
 
 mkgallery.pl traverses directory tree starting from current directory

-downwards, and in each directory creates 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 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).
+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
+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).

 
 For the thing to work, you must create a subdirectory named ".include"
 at the root of your image gallery, or somewhere upstairs in the
 
 For the thing to work, you must create a subdirectory named ".include"
 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
+document tree, and put there files from the subdirectory "include"
+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,
 "mkgallery.pl" script.  First time, you will be asked to enter titles
 for all subdirectories ("Albums"); if you wish to recreate the titles,

-remove ".title" files.  If you *don't* want "index.html" to be generated
-in some directory, create a file ".noindex".  This way you can preserve
-index created by hand or by some other script.
+remove ".title" files or specify "--asktitles".  If you *don't* want
+"index.html" to be generated in some directory, create a file ".noindex"
+there.  This way you can preserve index created by hand or by some other
+script like "mkindex.pl".
+
+command-line options:
+ --help:       print help message and exit
+ --incpath:    do not try to find .include 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.
+
+The only way to specify titles for individual pictures is to write
+comments into the image files.

 
 "mkindex.pl" is a simple script that is completely unrelated to the
 gallery (theoretically).  If your tree starts with YYYY/DD (four
 
 "mkindex.pl" is a simple script that is completely unrelated to the
 gallery (theoretically).  If your tree starts with YYYY/DD (four

-digit year and two-digit month, this script will create a compact
+digit year and two-digit month), this script will create a compact

 table with references to individual months, and then a separate list
 table with references to individual months, and then a separate list

-for subdirectories that are not four-digit.
+of subdirectories that are not four-digit.

 
 Requirements:
 Image::Info
 
 Requirements:
 Image::Info

-Image::Magick (might get rid of that later)
-Term::ReadLine (not at this moment but planned)
+Image::Magick (optional. If not present, will run djeg|pnmscale|cjpeg pipe)
+Term::ReadLine

 
 

-Download:
-svn co svn://svn.average.org/mkgallery/trunk mkgallery
+Homepage:
+http://www.average.org/mkgallery/

 
 TODO:
 
 TODO:

-- in slide show, use original image if it was not scaled down
-- center info window relative to scroll position
-- tooltips for info and full image links
-- try to get get info from APP12 marker for non-EXIF files
-- really create info files
-- make slideshow "stylish", i.e. use CSS
-- make Image::Magick optional
-- make title editor based on Term::ReadLine
-- anything else that I forgot
+- make index.html depend of .title and directory timestamps
+- any ideas?

 
 Eugene Crosser <crosser at average dot org>
 
 Eugene Crosser <crosser at average dot org>