summaryrefslogtreecommitdiff
path: root/docs/photoalbum.txt
blob: 315b86b671fe3c8d89228773152cd533cb8da2d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
NAME
    photoalbum - photoalbum is a minimal bash script for linux to generate
    static web photo albums.

SYNOPSIS
    photoalbum [clean|init|version|generate|all]

    clean
        Cleans up the working space

    init
        Initializes the working space

    version
        Prints out the version

    generate
        Generates the static photoalbum

    all This just runs 'clean init generate' right after another.

  TUTORIAL
    * See if /etc/default/photoalbum fits your needs. If not, copy
    /etc/default/photoalbum to ~/.photoalbumrc in order to customize it.

    * Run 'photoalbum init'

    * Copy all images wanted to the incoming folder (see config file)

    * Run 'photoalbum generate'

    * Distribute the ./dist directory

    * Clean the mess up with 'photoalbum clean'

   HTML TEMPLATES
    Go to the templates directory and edit them as wished.

LICENSE
    See package description or project website.

AUTHOR
    Paul Buetow - <http://photoalbum.buetow.org>