Had fight with maven. It decided to block HTTP repositories.
[meviz.git] / doc / index.org
index 665f51c..5278111 100644 (file)
@@ -1,15 +1,5 @@
 #+TITLE: MeWiz - Media Wizard
 
-* (document settings) :noexport:
-** use dark style for TWBS-HTML exporter
-#+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
-#+HTML_HEAD: <style type="text/css">
-#+HTML_HEAD:   footer {background-color: #111 !important;}
-#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
-#+HTML_HEAD: </style>
-
 * General
 - This program is free software: released under Creative Commons Zero
   (CC0) license
 
 ** Source code
 - [[https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
-
 - [[https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=summary][Browse Git repository online]]
 
 - Clone Git repository using command:
   : git clone https://www2.svjatoslav.eu/git/meviz.git
 
-
 * Introduction
-
 The idea is to have something like a Swiss army knife of various tools
 for audio, video, photo editing/conversion.
 
@@ -45,6 +32,22 @@ Current functionality:
   and embedded video player.
 
 - Batch file rename.
-* TODO Usage
 
--- TODO --
+
+* 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.