Updated documentation
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Tue, 29 Mar 2022 15:11:58 +0000 (18:11 +0300)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Tue, 29 Mar 2022 15:11:58 +0000 (18:11 +0300)
doc/index.html
doc/index.org

index f145364..907c248 100644 (file)
@@ -3,7 +3,7 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
-<!-- 2022-03-29 Tue 18:01 -->
+<!-- 2022-03-29 Tue 18:11 -->
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <title>MeWiz - Media Wizard</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <title>MeWiz - Media Wizard</title>
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents">
 <ul>
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents">
 <ul>
-<li><a href="#org06bdc2d">1. General</a>
+<li><a href="#org8fef3f6">1. General</a>
 <ul>
 <ul>
-<li><a href="#org8cbf344">1.1. Source code</a></li>
+<li><a href="#orgdb7f89c">1.1. Source code</a></li>
+</ul>
+</li>
+<li><a href="#org1fdf04d">2. Introduction</a></li>
+<li><a href="#org0a08853">3. Installation</a></li>
+<li><a href="#orgf555c42">4. Usage</a>
+<ul>
+<li><a href="#orge5a4f8a">4.1. To generate or update existing image gallery</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a href="#orgbf8cc6a">2. Introduction</a></li>
 </ul>
 </div>
 </div>
 
 </ul>
 </div>
 </div>
 
-<div id="outline-container-org06bdc2d" class="outline-2">
-<h2 id="org06bdc2d"><span class="section-number-2">1</span> General</h2>
+<div id="outline-container-org8fef3f6" class="outline-2">
+<h2 id="org8fef3f6"><span class="section-number-2">1</span> General</h2>
 <div class="outline-text-2" id="text-1">
 <ul class="org-ul">
 <li>This program is free software: released under Creative Commons Zero
 <div class="outline-text-2" id="text-1">
 <ul class="org-ul">
 <li>This program is free software: released under Creative Commons Zero
 </ul>
 </div>
 
 </ul>
 </div>
 
-<div id="outline-container-org8cbf344" class="outline-3">
-<h3 id="org8cbf344"><span class="section-number-3">1.1</span> Source code</h3>
+<div id="outline-container-orgdb7f89c" class="outline-3">
+<h3 id="orgdb7f89c"><span class="section-number-3">1.1</span> Source code</h3>
 <div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
 <div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
@@ -270,8 +276,8 @@ git clone https://www2.svjatoslav.eu/git/meviz.git
 </div>
 </div>
 
 </div>
 </div>
 
-<div id="outline-container-orgbf8cc6a" class="outline-2">
-<h2 id="orgbf8cc6a"><span class="section-number-2">2</span> Introduction</h2>
+<div id="outline-container-org1fdf04d" class="outline-2">
+<h2 id="org1fdf04d"><span class="section-number-2">2</span> Introduction</h2>
 <div class="outline-text-2" id="text-2">
 <p>
 The idea is to have something like a Swiss army knife of various tools
 <div class="outline-text-2" id="text-2">
 <p>
 The idea is to have something like a Swiss army knife of various tools
@@ -294,10 +300,51 @@ and embedded video player.</li>
 </ul>
 </div>
 </div>
 </ul>
 </div>
 </div>
+
+
+<div id="outline-container-org0a08853" class="outline-2">
+<h2 id="org0a08853"><span class="section-number-2">3</span> Installation</h2>
+<div class="outline-text-2" id="text-3">
+<p>
+Study and run installer script:
+</p>
+<pre class="example">
+install
+</pre>
+</div>
+</div>
+
+
+<div id="outline-container-orgf555c42" class="outline-2">
+<h2 id="orgf555c42"><span class="section-number-2">4</span> Usage</h2>
+<div class="outline-text-2" id="text-4">
+</div>
+<div id="outline-container-orge5a4f8a" class="outline-3">
+<h3 id="orge5a4f8a"><span class="section-number-3">4.1</span> To generate or update existing image gallery</h3>
+<div class="outline-text-3" id="text-4-1">
+<ol class="org-ol">
+<li>Using terminal, navigate to desired destination directory.</li>
+<li><p>
+Issue command:
+</p>
+<pre class="example">
+meviz index
+</pre></li>
+</ol>
+
+<p>
+If there is existing image gallery, then <b>meviz</b> 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.
+</p>
+</div>
+</div>
+</div>
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2022-03-29 Tue 18:01</p>
+<p class="date">Created: 2022-03-29 Tue 18:11</p>
 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
index f6de47a..5278111 100644 (file)
@@ -32,3 +32,22 @@ Current functionality:
   and embedded video player.
 
 - Batch file rename.
   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.