From 5eb88328d9667fe7b96802dfdcd6178d0472fe9d Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Fri, 21 Apr 2017 15:17:19 +0200 Subject: [PATCH] README: convert to reStructuredText --- Makefile.am | 2 +- README => README.rst | 29 ++++++++++++++++------------- 2 files changed, 17 insertions(+), 14 deletions(-) rename README => README.rst (56%) diff --git a/Makefile.am b/Makefile.am index ac11c69..93b9257 100644 --- a/Makefile.am +++ b/Makefile.am @@ -198,7 +198,7 @@ endif doc_DATA = \ doc/config.sample doc/keys.sample doc/ncmpc.lirc \ - AUTHORS NEWS README + AUTHORS NEWS README.rst man_MANS = doc/ncmpc.1 if ENABLE_DOCUMENTATION diff --git a/README b/README.rst similarity index 56% rename from README rename to README.rst index c7d4ba3..64c5804 100644 --- a/README +++ b/README.rst @@ -1,9 +1,13 @@ +ncmpc +===== Overview ------------------------------------------------------------------------------- -ncmpc is a curses client for the Music Player Daemon (MPD). ncmpc connects to -a MPD running on a machine on the local network, and controls this with an -interface inspired by cplay. +-------- + +ncmpc is a curses client for the `Music Player Daemon +`__. ncmpc connects to a MPD running on a +machine on the local network, and controls this with an interface +inspired by cplay. Music Player Daemon (MPD) allows remote access for playing music (MP3, Ogg Vorbis, FLAC, AAC, and wave files) and managing playlists. MPD is @@ -13,28 +17,27 @@ control for music playback over a local network. Read more at musicpd.org How to compile and install ncmpc -------------------------------------------------------------------------------- +-------------------------------- -See the INSTALL file. +See the `INSTALL `__ file. Usage -------------------------------------------------------------------------------- +----- + ncmpc connects to a MPD running on a machine on the local network. By default, ncmpc connects to localhost:6600. This can be changed either at compile-time, or by exporting the MPD_HOST and -MPD_PORT environment variables, or by the command line options --host -and --port. +MPD_PORT environment variables, or by the command line options `--host` +and `--port`:: - $ ncmpc --host=musicserver --port=44000 + ncmpc --host=musicserver --port=44000 For more information please view ncmpc's manual page. - - Web Page, Forums and Bug Reports -------------------------------------------------------------------------------- +-------------------------------- Home page and download: http://www.musicpd.org/clients/ncmpc/ -- 2.30.2