mirror of
https://github.com/mpv-player/mpv
synced 2025-01-13 00:06:25 +01:00
README: add a new one using ReST
Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
This commit is contained in:
parent
5a412bfa09
commit
3d4763498a
27
README
27
README
@ -1,27 +0,0 @@
|
|||||||
|
|
||||||
Compiling with full features requires development files for several
|
|
||||||
external libraries. Below is a list of some important requirements. For
|
|
||||||
more information see the output of './configure --help' for a list of options,
|
|
||||||
or look at the list of enabled and disabled features printed after running
|
|
||||||
'./configure'. If you think you have support for some feature installed
|
|
||||||
but configure fails to detect it, the file config.log may contain information
|
|
||||||
about the reasons for the failure.
|
|
||||||
|
|
||||||
Libraries specific to particular video output methods
|
|
||||||
(you'll want at least one of VDPAU, GL or Xv):
|
|
||||||
- libvdpau (for VDPAU output, best choice for NVIDIA cards)
|
|
||||||
- libGL (OpenGL output)
|
|
||||||
- libXv (XVideo output)
|
|
||||||
general:
|
|
||||||
- libasound (ALSA audio output)
|
|
||||||
- various general X development libraries
|
|
||||||
- libfreetype (for libass)
|
|
||||||
- libfontconfig (for libass)
|
|
||||||
- libass
|
|
||||||
- FFmpeg libraries (libavutil libavcodec libavformat libswscale libpostproc)
|
|
||||||
|
|
||||||
Most of the above libraries are available in suitable versions on normal
|
|
||||||
Linux distributions. However FFmpeg is an exception (distro versions may be
|
|
||||||
too old to work at all or work well). For that reason you may want to use
|
|
||||||
the separately available build wrapper that first compiles FFmpeg libraries
|
|
||||||
and libass, and then compiles the player statically linked against those.
|
|
69
README.rst
Normal file
69
README.rst
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
mpv
|
||||||
|
###
|
||||||
|
|
||||||
|
Overview
|
||||||
|
========
|
||||||
|
|
||||||
|
**mpv** is a movie player based on MPlayer and mplayer2. It supports a wide
|
||||||
|
variety of video file formats, audio and video codecs, and subtitle types.
|
||||||
|
|
||||||
|
If you are wondering what's different from mplayer2 and MPlayer you can read
|
||||||
|
more about the changes_.
|
||||||
|
|
||||||
|
Compilation
|
||||||
|
===========
|
||||||
|
|
||||||
|
Compiling with full features requires development files for several
|
||||||
|
external libraries. Below is a list of some important requirements. For
|
||||||
|
more information see the output of ``./configure --help`` for a list of options,
|
||||||
|
or look at the list of enabled and disabled features printed after running
|
||||||
|
``./configure``. If you think you have support for some feature installed
|
||||||
|
but configure fails to detect it, the file ``config.log`` may contain
|
||||||
|
information about the reasons for the failure.
|
||||||
|
|
||||||
|
Essential dependencies (incomplete list):
|
||||||
|
|
||||||
|
- gcc or clang
|
||||||
|
- X development headers (xlib, X extensions, libvdpau, libGL, libXv, ...)
|
||||||
|
- Audio output development headers (libasound, pulseaudio)
|
||||||
|
- fribidi, freetype, fontconfig development headers (for libass)
|
||||||
|
- libass
|
||||||
|
- FFmpeg libraries (libavutil libavcodec libavformat libswscale libpostproc)
|
||||||
|
- libjpeg
|
||||||
|
- libquvi if you want to play Youtube videos directly
|
||||||
|
- libx264 if you want to use encoding (has to be explicitly enabled when
|
||||||
|
compiling ffmpeg)
|
||||||
|
|
||||||
|
Most of the above libraries are available in suitable versions on normal
|
||||||
|
Linux distributions. However FFmpeg is an exception (distro versions may be
|
||||||
|
too old to work at all or work well). For that reason you may want to use
|
||||||
|
the separately available build wrapper (mpv-build_) that first compiles FFmpeg
|
||||||
|
libraries and libass, and then compiles the player statically linked against
|
||||||
|
those.
|
||||||
|
|
||||||
|
If you are running Mac OSX and using homebrew we provide homebrew-mpv_, an up
|
||||||
|
to date formula that compiles mpv with sensible dependencies and defaults for
|
||||||
|
OSX.
|
||||||
|
|
||||||
|
Bug reports
|
||||||
|
===========
|
||||||
|
|
||||||
|
Please use the `issues tracker`_ provided by GitHub to send us bug reports or
|
||||||
|
feature requests.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Contacts
|
||||||
|
========
|
||||||
|
|
||||||
|
You can find us on IRC in ``#mpv-player`` on ``irc.freenode.net``
|
||||||
|
|
||||||
|
.. _changes: https://github.com/mpv-player/mpv/blob/master/DOCS/man/en/changes.rst
|
||||||
|
.. _mpv-build: https://github.com/mpv-player/mpv-build
|
||||||
|
.. _homebrew-mpv: https://github.com/mpv-player/homebrew-mpv
|
||||||
|
.. _issues tracker: https://github.com/mpv-player/mpv/issues
|
Loading…
Reference in New Issue
Block a user