Code refactoring
[meviz.git] / doc / index.org
1 #+TITLE: MeWiz - Media Wizard
2
3 * General
4 - This program is free software: released under Creative Commons Zero
5   (CC0) license
6
7 - Program author:
8   - Svjatoslav Agejenko
9   - Homepage: https://svjatoslav.eu
10   - Email: mailto://svjatoslav@svjatoslav.eu
11
12 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
13
14 ** Source code
15 - [[https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
16 - [[https://www2.svjatoslav.eu/gitweb/?p=meviz.git;a=summary][Browse Git repository online]]
17
18 - Clone Git repository using command:
19   : git clone https://www2.svjatoslav.eu/git/meviz.git
20
21 * Introduction
22 The idea is to have something like a Swiss army knife of various tools
23 for audio, video, photo editing/conversion.
24
25
26 Current functionality:
27
28 - Acts as unified frontend for linux commandline tools for audio,
29   video and photo conversion.
30
31 - Generates HTML listing for directory content with image thumbnails
32   and embedded video player.
33
34 - Batch file rename.
35
36
37 * Installation
38
39 Study and run installer script:
40 : install
41
42
43 * Usage
44
45 ** To generate or update existing image gallery
46 1. Using terminal, navigate to desired destination directory.
47 2. Issue command:
48    : meviz index
49
50 If there is existing image gallery, then *meviz* only generates
51 thumbnails for new images if needed. Old thumbnails that are no longer
52 needed are removed automatically. Idea is that it must be
53 computationally cheap to update gallery incrementally.