summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Buetow (mars.fritz.box) <paul@buetow.org>2013-12-29 14:44:31 +0100
committerPaul Buetow (mars.fritz.box) <paul@buetow.org>2013-12-29 14:44:31 +0100
commitb55acdbe8f517df23f7941df0ccd952005ea1929 (patch)
tree8a654baf9b5960e371dd922ee582d18372772bc2 /docs
parent3d23d6bc29dcbf714c916281091ebc594d3bc667 (diff)
i can use the package now
Diffstat (limited to 'docs')
-rw-r--r--docs/photoalbum.112
-rw-r--r--docs/photoalbum.txt13
2 files changed, 17 insertions, 8 deletions
diff --git a/docs/photoalbum.1 b/docs/photoalbum.1
index 3c8517c..1b0c4a4 100644
--- a/docs/photoalbum.1
+++ b/docs/photoalbum.1
@@ -133,14 +133,18 @@
photoalbum \- photoalbum is a minimal bash script for linux to generate static web photo albums.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
-photoalbum
+photoalbum [init|generate]
.SS "\s-1QUICK\s0 \s-1START\s0 \s-1GUIDE:\s0"
.IX Subsection "QUICK START GUIDE:"
-* Copy all images wanted to ./incoming
+* See if /etc/default/photoalbum fits your needs. If not, read on.
+.PP
+* Copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize it.
.PP
-* Edit photoalbum.conf
+* Run 'photoalbum init'
+.PP
+* Copy all images wanted to ./incoming
.PP
-* Run \*(L"make\*(R"
+* Run 'photoalbum generate'
.PP
* Distribute the ./dist directory
.PP
diff --git a/docs/photoalbum.txt b/docs/photoalbum.txt
index b4e1a87..9278ce9 100644
--- a/docs/photoalbum.txt
+++ b/docs/photoalbum.txt
@@ -3,14 +3,19 @@ NAME
static web photo albums.
SYNOPSIS
- photoalbum
+ photoalbum [init|generate]
QUICK START GUIDE:
- * Copy all images wanted to ./incoming
+ * See if /etc/default/photoalbum fits your needs. If not, read on.
+
+ * Copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize
+ it.
- * Edit photoalbum.conf
+ * Run 'photoalbum init'
+
+ * Copy all images wanted to ./incoming
- * Run "make"
+ * Run 'photoalbum generate'
* Distribute the ./dist directory