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, see :ref:`configuration-examples`.
  19
  20 **To queue tracks from similar artists:**
  21   - start playing a track in MPD
  22   - launch MPD_sima
  23
  24 .. code-block:: sh
  25
  26     # runs against localhost MPD (or whatever is set in MPD_HOST/MPD_PORT)
  27     mpd-sima
  28
  29     # runs against a specific MPD server
  30     mpd-sima --host mpd.example.org
  31
  32
  33 **To start in random queuing mode:**
  34
  35 .. code-block:: sh
  36
  37     # Adds 5 tracks at random when there is only 1 track in the queue
  38     mpd-sima random 5
  39
  40 #####################
  41 User's documentation
  42 #####################
  43
  44 .. toctree::
  45    :maxdepth: 2
  46    :glob:
  47
  48    user/*
  49
  50
  51 ############
  52 Unix Manuals
  53 ############
  54
  55 These manual pages were written for the Debian system (and may be used by others).
  56
  57 .. toctree::
  58    :maxdepth: 2
  59    :titlesonly:
  60
  61    man/mpd-sima.1.rst
  62    man/mpd_sima.cfg.5.rst
  63
  64
  65 ##########################
  66 Development documentation
  67 ##########################
  68
  69 .. toctree::
  70    :maxdepth: 2
  71    :titlesonly:
  72
  73    dev/mpdclient
  74    dev/meta
  75    dev/lastfm
  76    dev/cache
  77    dev/simadb
  78
  79
  80 ##################
  81 Indices and tables
  82 ##################
  83
  84 * :ref:`genindex`
  85 * :ref:`modindex`
  86 * :ref:`search`
  87
  88
  89 .. include:: links.rst
  90
  91 .. vim: spell spelllang=en