summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDiogo Franco (Kovensky) <diogomfranco@gmail.com>2015-04-13 19:55:48 +0900
committerDiogo Franco (Kovensky) <diogomfranco@gmail.com>2015-04-13 19:55:48 +0900
commit3287825bd2ee762a918961383604697358765397 (patch)
treed3513ec0b91a5c3832221c5b74225deb85fb2163 /README.md
parent9e65b5db0bf79b31c7816d1fdba77ea18fe82690 (diff)
parentf43017bfe97c07aa73206d8d1388294cdbee628f (diff)
downloadmpv-3287825bd2ee762a918961383604697358765397.tar.bz2
mpv-3287825bd2ee762a918961383604697358765397.tar.xz
Merge branch 'master' into release/0.9
* master: (39 commits) Update license headers af_lavrresample: minor simplification af_lavrresample: allow resetting output sample format audio/filter: fully renegotiate audio formats on every reconfig DOCS/waf: Edit --enable-feature sentences vo_opengl: slightly simplify check_gl_features() vo_opengl: unify blend-subtitles-res and blend-subtitles vo_opengl: fix blend-subtitles-res=video & anamorphic video manpage: mention how pseudo-gui mode is enabled on win32 main-fn-win: fix handle validity check for XP win32: use pseudo-gui profile when started without stdio win32: only attach to the console from mpv.com win32: use a platform-specific unicode entry-point vo_opengl: add blend-subtitles-res manpage: document pseudo-gui stuff mp_image: remove redundant flags field mp_image: remove redundant chroma_x/y_shift fields mp_image: remove redundant plane_w/h fields player: use config parser for setting up pseudo-gui profile player: change pseudo-gui settings ...
Diffstat (limited to 'README.md')
-rw-r--r--README.md64
1 files changed, 43 insertions, 21 deletions
diff --git a/README.md b/README.md
index 7c4b18b340..4f8676552f 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.
+with FFmpeg only (subtitle formats in particular).
-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)