diff options
| author | Paul Buetow <paul@buetow.org> | 2022-02-19 23:02:51 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2022-02-20 10:18:39 +0000 |
| commit | 38abc2ecb3cbc70aeb11d9d390d9a6ef53478a23 (patch) | |
| tree | 47b93bf8e569886f123dcf6b8d62167f7f31b0f1 /README.pod | |
| parent | 6feae6c65217e8b82c33d3fd4c15be09293ebf9f (diff) | |
ShellCheck OK now. Also, some refactorings.
Diffstat (limited to 'README.pod')
| -rw-r--r-- | README.pod | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/README.pod b/README.pod deleted file mode 100644 index 9c55dd7..0000000 --- a/README.pod +++ /dev/null @@ -1,58 +0,0 @@ -=head1 NAME - -photoalbum - photoalbum is a minimal bash script for linux to generate static web photo albums. - -=head1 SYNOPSIS - -photoalbum clean|generate|version|recursive:DIR [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://buetow.org> - -=cut |