summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Buetow (mars.fritz.box) <paul@buetow.org>2013-12-27 12:50:20 +0100
committerPaul Buetow (mars.fritz.box) <paul@buetow.org>2013-12-27 12:50:20 +0100
commit475ca77785db30a8b208f7057cf448a421d3fc13 (patch)
tree2ce7896547198bdfdb8267d86f1adb100a87e2bd /docs
parent8be53a7b5a51798e40ac75bbc1542f165d7d1ea2 (diff)
initial debian package version
Diffstat (limited to 'docs')
-rw-r--r--docs/README25
-rw-r--r--docs/photoalbum.pod22
2 files changed, 47 insertions, 0 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000..a4384d3
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,25 @@
+Project Homepage: http://photoalbum.buetow.org
+
+TOC:
+01. HELLO WORLD
+02. QUICK START GUIDE
+03. HTML TEMPLATES
+
+01. HELLO WORLD
+
+photoalbum is a minimal bash script for linux to generate static web photo albums.
+
+02. QUICK START GUIDE:
+
+* Copy all images wanted to ./incoming
+
+* Edit photoalbum.conf
+
+* Run "make"
+
+* Distribute the ./dist directory
+
+03. HTML TEMPLATES
+
+Go to the ./templates directory and edit them as wished.
+
diff --git a/docs/photoalbum.pod b/docs/photoalbum.pod
new file mode 100644
index 0000000..63ccb43
--- /dev/null
+++ b/docs/photoalbum.pod
@@ -0,0 +1,22 @@
+=head1 NAME
+
+cpuinfo - A small and humble tool to print out CPU data
+
+=head1 SYNOPSIS
+
+cpuinfo
+
+=head2 How this works?
+
+This just invokes AWK to parse /proc/cpuinfo and prints out some stuff but
+human readable.
+
+=head1 LICENSE
+
+See package description or project website.
+
+=head1 AUTHOR
+
+Paul Buetow - <http://cpuinfo.buetow.org>
+
+=cut