summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBenjamin Kiessling <mittagessen@l.unchti.me>2011-11-18 14:29:50 +0100
committerBenjamin Kiessling <mittagessen@l.unchti.me>2011-11-18 14:29:50 +0100
commita3ea440949c338351d2ee54eaf394025557af26d (patch)
treecb35d8c724c4ea84a77b70b4f237ebe2582655f5 /README
parenta129835566286d4486e0b574287692e8cddf940d (diff)
Add a horrible readme
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f60172c
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+slidonoscopy is a software to create individual HTML(5) based
+slideshows based on local data (text, images, videos...).
+
+Dependencies:
+=============
+
+slidonoscopy is written in node.js and requires some additional
+modules:
+ * connect
+ * express
+ * walk
+ * watch-tree
+
+Usage:
+======
+
+Edit config.js to reflect the location of your slideshows und metadata/event
+files. Slideshows are to be created under $dir with one directory per slideshow.
+
+$dir---slideshow1 -- events.js
+ | |___ slide1.jpg
+ | |___ slide2.jpg
+ | |___ video.mkv
+ | |___ desc.js
+ | |___ template.html
+ |
+ |___slideshow2 -- events.js
+ | |___ slide.jpg
+ | |___ template.html
+ |
+ |___slideshow3 -- events.js
+ |___ template.html
+
+The template is a simple HTML file where the key words $EVENTS and $IMAGES will
+be exchanged at runtime with the appropriate events and slides.
+Just execute
+ $ node main.js
+to run slidenoscopy. The server will listen on port 8080 and will serve all
+slideshows under slides/$name. Retrieving / will display a list of all
+available slideshows.