release v0.29

[ncmpc.git] / README.rst

diff --git a/README.rst b/README.rst
index 64c58040e226f6e7ff89345a4dfe28faa80f0c64..4cc7da39ec72e1d5dd30506b4e4ebc00a4ca74c2 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,25 +1,29 @@
 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
-
+<http://www.musicpd.org/>`__.
 
 
 How to compile and install ncmpc
 --------------------------------
 
-See the `INSTALL <INSTALL>`__ file.
+You need:
+
+- a C99 compliant compiler (e.g. gcc)
+- libmpdclient 2.9
+- `GLib 2.30 <https://developer.gnome.org/glib/>`__
+- `ncurses <https://www.gnu.org/software/ncurses/>`__
+- `Meson 0.37 <http://mesonbuild.com/>`__ and `Ninja <https://ninja-build.org/>`__
+
+Run ``meson``:
+
+ meson . output
+
+Compile and install::
+
+ ninja -C output
+ ninja -C output install
 
 
 Usage
@@ -28,25 +32,18 @@ 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
 
 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/
+Links
+-----
 
-Forum:
-        http://forum.musicpd.org/
+- `Home page and download <http://www.musicpd.org/clients/ncmpc/>`__
+- `git repository <https://github.com/MusicPlayerDaemon/ncmpc/>`__
+- `Bug tracker <https://github.com/MusicPlayerDaemon/ncmpc/issues>`__
+- `Forum <http://forum.musicpd.org/>`__