Updated documentation
[meviz.git] / doc / index.org
index f6de47a..5278111 100644 (file)
@@ -32,3 +32,22 @@ Current functionality:
   and embedded video player.
 
 - Batch file rename.
+
+
+* Installation
+
+Study and run installer script:
+: install
+
+
+* Usage
+
+** To generate or update existing image gallery
+1. Using terminal, navigate to desired destination directory.
+2. Issue command:
+   : meviz index
+
+If there is existing image gallery, then *meviz* only generates
+thumbnails for new images if needed. Old thumbnails that are no longer
+needed are removed automatically. Idea is that it must be
+computationally cheap to update gallery incrementally.