doc/source/index.rst

   1 .. MPD_sima documentation master file, created by
   2    sphinx-quickstart on Wed Nov 11 13:21:17 2015.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 #########################
   7 MPD_sima's documentation
   8 #########################
   9
  10 MPD_sima is meant to **auto-magically queue** tracks in MPD_, it is a non interactive client for MPD_.
  11
  12 Actually there is no magic involved, it relies on music metadata found in music
  13 files tags and external information providers such as last.fm_. Then to use
  14 MPD_sima (or any advanced music players, MPD_ among them), you need to ensure
  15 your library is correctly tagged (see :ref:`metadata-convention`).
  16
  17 The default setting for MPD_sima is to queue similar artists thanks to last.fm_
  18 suggestions but there are other possibilities.
  19
  20 **To queue tracks from similar artists, start playing a track in MPD then launch MPD_sima:**
  21
  22 .. code-block:: sh
  23
  24     # runs against localhost MPD (or whatever is set in MPD_HOST/MPD_PORT)
  25     mpd-sima
  26
  27     # runs against a specific MPD server
  28     mpd-sima --host mpd.example.org
  29
  30 #####################
  31 User's documentation
  32 #####################
  33
  34 .. toctree::
  35    :maxdepth: 2
  36    :glob:
  37
  38    user/*
  39
  40
  41 ##########################
  42 Development documentation
  43 ##########################
  44
  45 .. toctree::
  46    :maxdepth: 2
  47    :titlesonly:
  48
  49    dev/mpdclient
  50    dev/meta
  51    dev/lastfm
  52    dev/cache
  53    dev/simadb
  54
  55
  56 Indices and tables
  57 ==================
  58
  59 * :ref:`genindex`
  60 * :ref:`modindex`
  61 * :ref:`search`
  62
  63
  64 .. include:: links.rst
  65
  66 .. vim: spell spelllang=en