Improved documentation.

[instantlauncher.git] / doc / index.html
diff --git a/doc/index.html b/doc/index.html

index d67058c..068ef9a 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -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>
-<!-- 2016-11-21 Mon 08:21 -->
+<!-- 2016-11-21 Mon 22:12 -->
  <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
  <meta  name="viewport" content="width=device-width, initial-scale=1" />
  <title>Instantlauncher - navigate to your files and programs quickly!</title>
@@ -149,8 +149,10 @@ for the JavaScript code in this tag.
  <h2>Table of Contents</h2>
  <div id="text-table-of-contents">
  <ul>
-<li><a href="#orgheadline1">1. Usage</a></li>
-<li><a href="#orgheadline2">2. <span class="todo TODO">TODO</span> </a></li>
+<li><a href="#orgheadline1">1. General description</a></li>
+<li><a href="#orgheadline2">2. Usage</a></li>
+<li><a href="#orgheadline3">3. Configuration</a></li>
+<li><a href="#orgheadline4">4. <span class="todo TODO">TODO</span> </a></li>
  </ul>
  </div>
  </div>
@@ -174,18 +176,81 @@ published by the Free Software Foundation.</li>
  
  
  <div id="outline-container-orgheadline1" class="outline-2">
-<h2 id="orgheadline1"><span class="section-number-2">1</span> Usage</h2>
+<h2 id="orgheadline1"><span class="section-number-2">1</span> General description</h2>
  <div class="outline-text-2" id="text-1">
  <p>
-TODO:
+Quick filesystem based document/application launcher. It starts by showing
+content of predefined directory. Sub directories can be chosen by simply moving
+mouse pointer over corresponding directory.
+</p>
+
+
+<div class="figure">
+<p><img src="screenshot.png" alt="screenshot.png" />
  </p>
-</div>
  </div>
  
+<p>
+Files types are color-coded.
+</p>
+</div>
+</div>
  
  <div id="outline-container-orgheadline2" class="outline-2">
-<h2 id="orgheadline2"><span class="section-number-2">2</span> <span class="todo TODO">TODO</span> </h2>
+<h2 id="orgheadline2"><span class="section-number-2">2</span> Usage</h2>
  <div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>Executable file:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Run executable file.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Toggle executable state.</li>
+</ul></li>
+</ul></li>
+
+<li>Non-executable file:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Open file using corresponding application.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Toggle executable state.</li>
+</ul></li>
+</ul></li>
+
+<li>Directory/symlink:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Open directory using configured filesystem browser.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Open directory using configured text based terminal emulator.</li>
+</ul></li>
+</ul></li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-orgheadline3" class="outline-2">
+<h2 id="orgheadline3"><span class="section-number-2">3</span> Configuration</h2>
+<div class="outline-text-2" id="text-3">
+<p>
+TODO:
+</p>
+</div>
+</div>
+
+<div id="outline-container-orgheadline4" class="outline-2">
+<h2 id="orgheadline4"><span class="section-number-2">4</span> <span class="todo TODO">TODO</span> </h2>
+<div class="outline-text-2" id="text-4">
  <p>
  TODO:
  </p>
@@ -194,7 +259,7 @@ TODO:
  </div>
  <div id="postamble" class="status">
  <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2016-11-21 Mon 08:21</p>
+<p class="date">Created: 2016-11-21 Mon 22:12</p>
  <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
  </div>
  </body>