From d334c308ed9bec19cbe37c5fe343071bdaf8c3d7 Mon Sep 17 00:00:00 2001
From: Vincent Riquer <vincent+gitorious@riquer.fr>
Date: Sat, 9 Mar 2013 14:36:28 +0100
Subject: [PATCH] update documentation

---
 README     | 36 +++++++++++++++++++++++++++++++++++-
 doc/config | 15 ++++++++-------
 2 files changed, 43 insertions(+), 8 deletions(-)

diff --git a/README b/README
index 12efed8..9212e4d 100644
--- a/README
+++ b/README
@@ -1,5 +1,39 @@
 AtOM: Anything to Ogg and Mp3
 
+URL: http://gitorious.org/atom
 Author: Vincent Riquer <vincent+prog.atom@riquer.fr>
-Copyright/left: 2012 Vincent Riquer - GPLv3 (see doc/GPL-3)
+Copyright/left: 2012-2013 Vincent Riquer - GPLv3 (see doc/GPL-3)
 	except: transogg: WTFPL 2.0
+
+============
+Dependencies
+------------
+Required:
+* bash (>= 4.0)
+  http://www.gnu.org/software/bash/bash.html
+* SoX
+  http://sox.sourceforge.net/
+* SQLite
+  http://www.sqlite.org/
+
+Optional:
+* vorbis-tools
+  http://www.vorbis.com/
+    * ogginfo (Ogg Vorbis tags support)
+    * oggenc (Ogg Vorbis destination)
+* LAME MP3 Encoder
+  http://lame.sourceforge.net/
+    * lame (MP3 destination)
+* FLAC
+  http://flac.sourceforge.net/
+    * metaflac (FLAC tags support)
+* Musepack
+  http://www.musepack.net/
+    * mpcdec (Musepack tags support, Musepack decoding)
+
+==================
+Using the software
+------------------
+Configuration:
+Please read doc/config before anything else.
+
diff --git a/doc/config b/doc/config
index b13f23e..5e535f0 100644
--- a/doc/config
+++ b/doc/config
@@ -4,7 +4,7 @@ Default config file is ~/.atom/atom.cfg.
 
 The file is divided in sections, beginning with [<sectionname>]. The section
 ends where the next one begins. Inside each sections, properties are defined
-with <key><space><value>, where <space can be either spaces, tabulations, or a
+with <key><space><value>, where <space> can be either spaces, tabulations, or a
 mix of both. <key> is always a single word. <value> shall never be quoted,
 whether it contains spaces or not.
 
@@ -26,13 +26,14 @@ Sections:
       too quickly. Set this too high, and AtOM will not adapt quickly enough to
       load increase. In both cases, your hard drive will suffer. In my
       experience, 30 seconds is a good value.
-  * temporary-directory <directory>: String. Name speaks for itself:this is where FIFOs (for
-      communicating with sqlite) and temporary WAVE files will be created.
-      Note that debug logs (if enabled) will go there too.
+  * temporary-directory <directory>: String. Name speaks for itself: this is
+      where FIFOs (for communicating with sqlite) and temporary WAVE files will
+      be created.  Note that debug logs (if enabled) will go there too.
       Default: ~/.atom/tmp
   * database <file>: String. Where the SQLite databse should be stored.
       Default: ~/.atom/atom.db
   * debug <level>: Integer. Currently defined values:
+      * 1: few additional status informations.
       * 3: log SQL queries.
 
 [source]
@@ -41,7 +42,7 @@ Sections:
   * path <directory>: String. The root of your collection.
       Default: /var/lib/mpd/music
   * skip <directory>: String. Files in <directory> will be ignored. Note that
-    <directory> can be any expression accepted by find.
+      <directory> can be any expression accepted by find.
 
 [<some arbitrary string>]
   Each section not named 'general' or 'source' will define a new destination.
@@ -49,8 +50,8 @@ Sections:
   Common parameters:
    Mandatory parameters:
     * path: Where files will be written
-    * format: ogg or mp3 (other formats may appear in the future - feel free to
-      implement your preferred format. A good candidate is FIXME).
+    * format: ogg or mp3. Other formats may appear in the future - feel free to
+      implement your preferred format. A good candidate is Opus (RFC 6716).
 
    Optional parameters:
     * normalize <yes>/<no>: Normalize output files.