README.rst: bug tracking now on GitHub
[ncmpc.git] / README.rst
blob7cd32e5d8acf9a1aa555a5f30fb8720a4ab74f80
1 ncmpc
2 =====
4 ncmpc is a curses client for the `Music Player Daemon
5 <http://www.musicpd.org/>`__.
8 How to compile and install ncmpc
9 --------------------------------
11 See the `INSTALL <INSTALL>`__ file.
14 Usage
15 -----
17 ncmpc connects to a MPD running on a machine on the local network. 
18 By default, ncmpc  connects  to  localhost:6600.   This  can  be
19 changed  either  at  compile-time,  or  by  exporting  the MPD_HOST and
20 MPD_PORT environment variables, or by the command line options ``--host``
21 and ``--port``::
23  ncmpc --host=musicserver --port=44000
25 For more information please view ncmpc's manual page.
28 Web Page, Forums and Bug Reports
29 --------------------------------
31 Home page and download:
32         http://www.musicpd.org/clients/ncmpc/
34 MPD's home page:
35         http://www.musicpd.org/
37 Bug tracker:
38         https://github.com/MusicPlayerDaemon/ncmpc/issues
40 Forum:
41         http://forum.musicpd.org/