Added preliminary documentation.

[meviz.git] / doc / index.org

diff --git a/doc/index.org b/doc/index.org
new file mode 100644 (file)
index 0000000..665f51c
--- /dev/null
+++ b/doc/index.org
@@ -0,0 +1,50 @@
+#+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
+
+- Program author:
+  - Svjatoslav Agejenko
+  - Homepage: https://svjatoslav.eu
+  - Email: mailto://svjatoslav@svjatoslav.eu
+
+- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
+
+** 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.
+
+
+Current functionality:
+
+- Acts as unified frontend for linux commandline tools for audio,
+  video and photo conversion.
+
+- Generates HTML listing for directory content with image thumbnails
+  and embedded video player.
+
+- Batch file rename.
+* TODO Usage
+
+-- TODO --