X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Findex.rst;h=09f16da222209c954ba304c54dd57958755f73f1;hb=a4fa4242a328252a2deb7d3fa9acaa59741dad8e;hp=ea579367ae32ee50be2bdc287a7ab1bcbbde4879;hpb=7a017681a7646e8f8a3d7226b4ae9e1f6d7dbf41;p=mpd-sima.git

diff --git a/doc/source/index.rst b/doc/source/index.rst
index ea57936..09f16da 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,15 +3,55 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to MPD_sima's documentation!
-====================================
+#########################
+MPD_sima's documentation
+#########################
 
-Contents:
+MPD_sima is meant to **auto-magically queue** tracks in MPD_, it is a non interactive client for MPD_.
+
+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
+
+    # 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
+   :titlesonly:
+
+   dev/mpdclient
+   dev/meta
+   dev/lastfm
+   dev/cache
+   dev/simadb
+
 
 Indices and tables
 ==================
@@ -20,3 +60,7 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+
+.. include:: links.rst
+
+.. vim: spell spelllang=en