README.rst

   1 ncmpc
   2 =====
   3
   4 ncmpc is a curses client for the `Music Player Daemon
   5 <http://www.musicpd.org/>`__.
   6
   7 .. image:: https://www.musicpd.org/clients/ncmpc/screenshot.png
   8   :alt: Screenshot of ncmpc
   9
  10
  11 How to compile and install ncmpc
  12 --------------------------------
  13
  14 You need:
  15
  16 - a C++14 compliant compiler (e.g. gcc or clang)
  17 - `libmpdclient <https://www.musicpd.org/libs/libmpdclient/>`__ 2.9
  18 - `Boost 1.62 <https://www.boost.org/>`__
  19 - `ncurses <https://www.gnu.org/software/ncurses/>`__
  20 - `Meson 0.47 <http://mesonbuild.com/>`__ and `Ninja <https://ninja-build.org/>`__
  21
  22 Optional:
  23
  24 - `PCRE <https://www.pcre.org/>`__ (for regular expression support in
  25   the "find" command)
  26 - `liblirc <https://sourceforge.net/projects/lirc/>`__ (for infrared
  27   remote support)
  28 - `Sphinx <http://www.sphinx-doc.org/en/master/>`__ (for building
  29   documentation)
  30
  31 Run ``meson``::
  32
  33  meson . output
  34
  35 Compile and install::
  36
  37  ninja -C output
  38  ninja -C output install
  39
  40
  41 Links
  42 -----
  43
  44 - `Home page and download <http://www.musicpd.org/clients/ncmpc/>`__
  45 - `Documentation <https://www.musicpd.org/doc/ncmpc/html/>`__
  46 - `git repository <https://github.com/MusicPlayerDaemon/ncmpc/>`__
  47 - `Bug tracker <https://github.com/MusicPlayerDaemon/ncmpc/issues>`__
  48 - `Help translate ncmpc to your native language <https://hosted.weblate.org/projects/ncmpc/>`__
  49 - `Forum <http://forum.musicpd.org/>`__