X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Findex.rst;h=b3dc0d8218a329d48461489b3fcd7dff847e7ca2;hb=db35ea171e147ed3d65bdab0e2f14caaf96582f9;hp=bd31cac19c7bfaaaeca69717a0ad4b0395bd6f80;hpb=80b4a0bf95fc816511966f79c91c6e16eda74b79;p=mpd-sima.git

diff --git a/doc/source/index.rst b/doc/source/index.rst
index bd31cac..b3dc0d8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,14 +3,68 @@
    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_.
+
+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, see :ref:`configuration-examples`.
+
+**To queue tracks from similar artists:**
+  - start playing a track in MPD
+  - 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
 
-Development documentation
--------------------------
 
-**Contents:**
+**To start in random queuing mode:**
+
+.. code-block:: sh
+
+    # Adds 5 tracks at random when there is only 1 track in the queue
+    mpd-sima random 5
+
+#####################
+User's documentation
+#####################
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   user/*
+
+
+############
+Unix Manuals
+############
+
+These manual pages were written for the Debian system (and may be used by others).
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   man/mpd-sima.1.rst
+   man/mpd_sima.cfg.5.rst
+
+
+##########################
+Development documentation
+##########################
 
 .. toctree::
    :maxdepth: 2
@@ -20,12 +74,18 @@ Development documentation
    dev/meta
    dev/lastfm
    dev/cache
+   dev/simadb
 
 
+##################
 Indices and tables
-==================
+##################
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
 
+
+.. include:: links.rst
+
+.. vim: spell spelllang=en