diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/photoalbum.pod | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/docs/photoalbum.pod b/docs/photoalbum.pod index 401f9a5..543fb89 100644 --- a/docs/photoalbum.pod +++ b/docs/photoalbum.pod @@ -4,22 +4,42 @@ photoalbum - photoalbum is a minimal bash script for linux to generate static we =head1 SYNOPSIS -photoalbum [init|generate] +photoalbum [clean|init|version|generate] -=head2 QUICK START GUIDE: +=over -* See if /etc/default/photoalbum fits your needs. If not, read on. +=item clean -* Copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize it. +Cleans up the working space + +=item init + +Initializes the working space + +=item version + +Prints out the version + +=item generate + +Generates the static photoalbum + +=back + +=head2 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 ./incoming +* 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' + =head3 HTML TEMPLATES Go to the templates directory and edit them as wished. |