]> git.sommitrealweird.co.uk Git - bpgallery.git/blob - README
Update TODO and README
[bpgallery.git] / README
1 Introduction
2 ------------
3 bpgallery is a small static gallery generator, it generates an index file and
4 thumbnails of your images. The index file is generated in the image folder,
5 icons in a subfolder called icons.
6
7 Requirements
8 ------------
9 The ImageMagick tools (convert and identify)
10 bash
11 GNU find
12 GNU xargs
13 sed
14
15 Installation
16 ------------
17 Copy the file bpgallery.sh to a directory in your PATH.
18
19 Usage
20 -----
21 bpgallery.sh /path/to/image/files
22
23 Also, the following files, if placed in the images directory, will be used to
24 generate part of the index page:
25         description.txt - a simple text file containing paragraphs to go at the
26                           beginnings of the index page
27         captions.txt - filename<tab>caption style file, it'll add a caption to
28                        the images on the index page.
29 The following environment variables can also be used:
30         TITLE - the title of the gallery
31         WIDTH - the width to make the icons
32
33 Example Usage:
34         TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
35
36 Author
37 ------
38 Brett Parker:
39         e-mail: <iDunno@sommitrealweird.co.uk>
40         www:    http://www.sommitrealweird.co.uk/