summaryrefslogtreecommitdiff
path: root/README.pod
blob: 242860f4f0cc2d72c010b26b929dcf2125a8dd66 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
=head1 NAME

photoalbum - photoalbum is a minimal bash script for linux to generate static web photo albums.

=head1 SYNOPSIS

photoalbum clean|version|generate [rcfile]
photoalbum makemake

=over

=item clean

Cleans up the working space

=item version

Prints out the version

=item generate

Generates the static photoalbum

=item makemake

Creates a Makefile and photoalbumrc in the current working directory.

=back

=head2 RCFILE

=head2 TUTORIAL

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

* 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'

It is possible to specify a custom rcfile path too.

=head3 HTML TEMPLATES

Go to the templates directory and edit them as wished.

=head1 LICENSE

See package description or project website.

=head1 AUTHOR

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

=cut