summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCris <CrisBRM@users.noreply.github.com>2015-04-03 17:20:59 +0100
committerwm4 <wm4@nowhere>2015-04-09 20:36:39 +0200
commit13a0ff8cb79473e971c2de3090616bae1905b78f (patch)
treedae0a0e41b7d5d09439586dab519cd455133387e
parentc4faab48714e6597cb12abe7be4aada694bac897 (diff)
downloadmpv-13a0ff8cb79473e971c2de3090616bae1905b78f.tar.bz2
mpv-13a0ff8cb79473e971c2de3090616bae1905b78f.tar.xz
Update README.md
Signed-off-by: wm4 <wm4@nowhere>
-rw-r--r--README.md62
1 files changed, 42 insertions, 20 deletions
diff --git a/README.md b/README.md
index 7c4b18b340..0ca0193c48 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,39 @@
-mpv
-===
+![http://mpv.io/](https://raw.githubusercontent.com/mpv-player/mpv.io/master/source/images/mpv-logo-128.png)
+
+## mpv
+
+--------------
+
+
+* [Overview](#overview)
+* [Downloads](#downloads)
+* [Compilation](#compilation)
+* [FFmpeg vs. Libav](#ffmpeg-vs-libav)
+* [Release cycle](#release-cycle)
+* [Bug reports](#bug-reports)
+* [Contributing](#contributing)
+* [Relation to MPlayer and mplayer2](#relation-to-mplayer-and-mplayer2)
+* [Wiki](https://github.com/mpv-player/mpv/wiki)
+* [Man pages](http://mpv.io/manual/master/)
+* [Contact](#contact)
+* [License](#license)
+
+## Overview
-Overview
---------
**mpv** is a media player based on MPlayer and mplayer2. It supports a wide
variety of video file formats, audio and video codecs, and subtitle types.
Releases can be found on the [release list][releases].
-Downloads
----------
+## Downloads
+
For semi-official builds and third-party packages please see
[mpv.io](http://mpv.io/installation/).
-Compilation
------------
+## Compilation
+
Compiling with full features requires development files for several
external libraries. Below is a list of some important requirements.
@@ -89,16 +106,16 @@ OSX.
If you want to build a Windows binary, you either have to use MSYS2 and MinGW,
or cross-compile from Linux with MinGW. See [Windows compilation][windows_compilation].
-FFmpeg vs. Libav
-----------------
+## FFmpeg vs. Libav
+
Generally, mpv should work with the latest release as well as the git version
of both FFmpeg and Libav. But FFmpeg is preferred, and some mpv features work
with FFmpeg only. See the [wiki article][ffmpeg_vs_libav] about the issue.
-Release cycle
--------------
+## Release cycle
+
Every few months, a new release is cut off of the master branch and is assigned
a 0.X.0 version number.
@@ -116,21 +133,21 @@ Releases other than the latest release are unsupported and unmaintained.
See the [release policy document][release-policy] for more information.
-Bug reports
------------
+## Bug reports
+
Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug
reports or feature requests.
-Contributing
-------------
+## Contributing
+
For small changes you can just send us pull requests through GitHub. For bigger
changes come and talk to us on IRC before you start working on them. It will
make code review easier for both parties later on.
-Relation to MPlayer and mplayer2
---------------------------------
+## Relation to MPlayer and mplayer2
+
mpv is based on mplayer2, which in turn is based on the original MPlayer
(also called mplayer, mplayer-svn, mplayer1). Many changes have been made, a
@@ -151,8 +168,8 @@ MPlayer drop-in replacement.
If you are wondering what's different from mplayer2 and MPlayer, an incomplete
list of changes is located [here][mplayer-changes].
-Contact
--------
+## Contact
+
Most activity happens on the IRC channel and the github issue tracker. The
mailing lists are mostly unused.
@@ -176,3 +193,8 @@ only if discretion is required.
[release-policy]: https://github.com/mpv-player/mpv/blob/master/DOCS/release-policy.md
[windows_compilation]: https://github.com/mpv-player/mpv/blob/master/DOCS/compile-windows.md
[mplayer-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/mplayer-changes.rst
+
+## License
+
+
+[GPLv2](https://github.com/mpv-player/mpv/blob/master/LICENSE)