summaryrefslogtreecommitdiff
path: root/docs/photoalbum.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/photoalbum.txt')
-rw-r--r--docs/photoalbum.txt24
1 files changed, 18 insertions, 6 deletions
diff --git a/docs/photoalbum.txt b/docs/photoalbum.txt
index 9278ce9..a111807 100644
--- a/docs/photoalbum.txt
+++ b/docs/photoalbum.txt
@@ -3,22 +3,34 @@ NAME
static web photo albums.
SYNOPSIS
- photoalbum [init|generate]
+ photoalbum [clean|init|version|generate]
- QUICK START GUIDE:
- * See if /etc/default/photoalbum fits your needs. If not, read on.
+ clean
+ Cleans up the working space
- * Copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize
- it.
+ init
+ Initializes the working space
+
+ version
+ Prints out the version
+
+ generate
+ Generates the static photoalbum
+
+ 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'
+
HTML TEMPLATES
Go to the templates directory and edit them as wished.