doc: Update sphinx config, add user documentation

[mpd-sima.git] / doc / source / index.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index bd31cac19c7bfaaaeca69717a0ad4b0395bd6f80..09f16da222209c954ba304c54dd57958755f73f1 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,14 +3,44 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-MPD_sima's documentation!
-=========================
+#########################
+MPD_sima's documentation
+#########################
 
+MPD_sima is meant to **auto-magically queue** tracks in MPD_, it is a non interactive client for MPD_.
 
-Development documentation
--------------------------
+Actually there is no magic involved, it relies on music metadata found in music
+files tags and external information providers such as last.fm_. Then to use
+MPD_sima (or any advanced music players, MPD_ among them), you need to ensure
+your library is correctly tagged (see :ref:`metadata-convention`).
+
+The default setting for MPD_sima is to queue similar artists thanks to last.fm_
+suggestions but there are other possibilities.
+
+**To queue tracks from similar artists, start playing a track in MPD then launch MPD_sima:**
+
+.. code-block:: sh
 
-**Contents:**
+    # runs against localhost MPD (or whatever is set in MPD_HOST/MPD_PORT)
+    mpd-sima
+
+    # runs against a specific MPD server
+    mpd-sima --host mpd.example.org
+
+#####################
+User's documentation
+#####################
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   user/*
+
+
+##########################
+Development documentation
+##########################
 
 .. toctree::
    :maxdepth: 2
@@ -20,6 +50,7 @@ Development documentation
    dev/meta
    dev/lastfm
    dev/cache
+   dev/simadb
 
 
 Indices and tables
@@ -29,3 +60,7 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+
+.. include:: links.rst
+
+.. vim: spell spelllang=en