From 55413b4e5a1c3fb76d77e20ea67fd29853083c7e Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 29 Mar 2022 18:11:58 +0300 Subject: [PATCH] Updated documentation --- doc/index.html | 69 ++++++++++++++++++++++++++++++++++++++++++-------- doc/index.org | 19 ++++++++++++++ 2 files changed, 77 insertions(+), 11 deletions(-) diff --git a/doc/index.html b/doc/index.html index f145364..907c248 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + MeWiz - Media Wizard @@ -224,18 +224,24 @@

Table of Contents

-
-

1 General

+
+

1 General

  • This program is free software: released under Creative Commons Zero @@ -252,8 +258,8 @@
-
-

1.1 Source code

+
+

1.1 Source code

-
-

2 Introduction

+
+

2 Introduction

The idea is to have something like a Swiss army knife of various tools @@ -294,10 +300,51 @@ and embedded video player.

+ + +
+

3 Installation

+
+

+Study and run installer script: +

+
+install
+
+
+
+ + +
+

4 Usage

+
+
+
+

4.1 To generate or update existing image gallery

+
+
    +
  1. Using terminal, navigate to desired destination directory.
    2. +

  2. +Issue command: +

    +
    +meviz index
+
    3. +
+ +

+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. +

+
+
+

Author: Svjatoslav Agejenko

-

Created: 2022-03-29 Tue 18:01

+

Created: 2022-03-29 Tue 18:11

Validate

diff --git a/doc/index.org b/doc/index.org index f6de47a..5278111 100644 --- a/doc/index.org +++ b/doc/index.org @@ -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. -- 2.20.1