From: Max Kellermann <max.kellermann@gmail.com>
Date: Fri, 21 Apr 2017 13:17:19 +0000 (+0200)
Subject: README: convert to reStructuredText
X-Git-Tag: v0.28~25
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=5eb88328d9667fe7b96802dfdcd6178d0472fe9d;p=ncmpc.git

README: convert to reStructuredText
---

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
deleted file mode 100644
index c7d4ba3..0000000
--- a/README
+++ /dev/null
@@ -1,49 +0,0 @@
-
-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. 
-
-Music Player Daemon (MPD) allows remote access for playing music (MP3, 
-Ogg Vorbis, FLAC, AAC, and wave files) and managing playlists. MPD is 
-designed for integrating a computer into a stereo system that provides 
-control for music playback over a local network. Read more at musicpd.org
-
-
-
-How to compile and install ncmpc
--------------------------------------------------------------------------------
-
-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.
-
-	$ 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/
-
-MPD's home page:
-        http://www.musicpd.org/
-
-Bug tracker:
-        http://bugs.musicpd.org/
-
-Forum:
-        http://forum.musicpd.org/
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..64c5804
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,52 @@
+ncmpc
+=====
+
+Overview
+--------
+
+ncmpc is a curses client for the `Music Player Daemon
+<http://www.musicpd.org/>`__.  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 
+designed for integrating a computer into a stereo system that provides 
+control for music playback over a local network. Read more at musicpd.org
+
+
+
+How to compile and install ncmpc
+--------------------------------
+
+See the `INSTALL <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`::
+
+ 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/
+
+MPD's home page:
+        http://www.musicpd.org/
+
+Bug tracker:
+        http://bugs.musicpd.org/
+
+Forum:
+        http://forum.musicpd.org/