RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity
mpv/README.md

237 lines
8.8 KiB
Markdown
Raw Normal View History

Improve readme aesthetics. This fixes the line under the header, creates a title header, and slightly improves list formatting.
2018-09-23 03:34:38 +00:00
![mpv logo](https://raw.githubusercontent.com/mpv-player/mpv.io/master/source/images/mpv-logo-128.png)
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
Improve readme aesthetics. This fixes the line under the header, creates a title header, and slightly improves list formatting.
2018-09-23 03:34:38 +00:00
# mpv
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
README: reorganize table of contents Add missing sections, make order consistent, create a new section for external links and rename "Manual" link.
2017-12-13 01:51:13 +00:00
* [External links](#external-links)
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
* [Overview](#overview)
README: reorganize table of contents Add missing sections, make order consistent, create a new section for external links and rename "Manual" link.
2017-12-13 01:51:13 +00:00
* [System requirements](#system-requirements)
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
* [Downloads](#downloads)
README: add links to various changelogs We're too lazy to maintain a full changelog, but there are still a bunch of places which document specific changes. A user really should check them on each update, even if there are transition periods (including printing warnings etc.) for most changes. It's a good idea to give them more exposure by adding them to the README.
2016-11-15 22:42:33 +00:00
* [Changelog](#changelog)
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
* [Compilation](#compilation)
* [Release cycle](#release-cycle)
* [Bug reports](#bug-reports)
* [Contributing](#contributing)
README: reorganize table of contents Add missing sections, make order consistent, create a new section for external links and rename "Manual" link.
2017-12-13 01:51:13 +00:00
* [License](#license)
* [Contact](#contact)
## External links
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
* [Wiki](https://github.com/mpv-player/mpv/wiki)
README.md: fix dead FAQ link due to syntax error
2019-11-09 04:28:47 +00:00
* [FAQ][FAQ]
DOCS: convert mpv.io and github links to https Discovered with: find . -type f \( -name '*.md' -o -name '*.rst' \) -exec grep -n 'http://' {} + All links to mpv.io or github.com/mpv-player that were http were converted to https.
2021-08-12 23:23:36 +00:00
* [Manual](https://mpv.io/manual/master/)
README: reorganize table of contents Add missing sections, make order consistent, create a new section for external links and rename "Manual" link.
2017-12-13 01:51:13 +00:00
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Overview
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00: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.
2012-11-13 06:25:28 +00:00
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
**mpv** is a free (as in freedom) media player for the command line. It supports
a wide variety of media file formats, audio and video codecs, and subtitle types.
README.md: fix dead FAQ link due to syntax error
2019-11-09 04:28:47 +00:00
There is a [FAQ][FAQ].
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.
2012-11-13 06:25:28 +00:00
README: fix typos
2015-03-04 17:53:40 +00:00
Releases can be found on the [release list][releases].
README: add some better links Also write something about MPlayer, since this is a frequently asked question.
2015-03-04 11:03:24 +00:00
README: add something about system requirements This is actually all bullshit. There are many factors that can ruin the video playback experience (and most outside of our or the user's control). One thing that makes sense is that this declares incompatibility with Windows XP (fixes #2473).
2015-11-22 17:19:35 +00:00
## System requirements
README: some rewording and markdown improvements
2017-12-13 02:18:55 +00:00
- A not too ancient Linux, Windows 7 or later, or OSX 10.8 or later.
- A somewhat capable CPU. Hardware decoding might help if the CPU is too slow to
decode video in realtime, but must be explicitly enabled with the `--hwdec`
option.
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
- A not too crappy GPU. mpv's focus is not on power-efficient playback on
embedded or integrated GPUs (for example, hardware decoding is not even
enabled by default). Low power GPUs may cause issues like tearing, stutter,
etc. The main video output uses shaders for video rendering and scaling,
rather than GPU fixed function hardware. On Windows, you might want to make
sure the graphics drivers are current. In some cases, ancient fallback video
output methods can help (such as `--vo=xv` on Linux), but this use is not
recommended or supported.
README: add something about system requirements This is actually all bullshit. There are many factors that can ruin the video playback experience (and most outside of our or the user's control). One thing that makes sense is that this declares incompatibility with Windows XP (fixes #2473).
2015-11-22 17:19:35 +00:00
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Downloads
README: add some better links Also write something about MPlayer, since this is a frequently asked question.
2015-03-04 11:03:24 +00:00
For semi-official builds and third-party packages please see
DOCS: convert mpv.io and github links to https Discovered with: find . -type f \( -name '*.md' -o -name '*.rst' \) -exec grep -n 'http://' {} + All links to mpv.io or github.com/mpv-player that were http were converted to https.
2021-08-12 23:23:36 +00:00
[mpv.io/installation](https://mpv.io/installation/).
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.
2012-11-13 06:25:28 +00:00
README: add links to various changelogs We're too lazy to maintain a full changelog, but there are still a bunch of places which document specific changes. A user really should check them on each update, even if there are transition periods (including printing warnings etc.) for most changes. It's a good idea to give them more exposure by adding them to the README.
2016-11-15 22:42:33 +00:00
## Changelog
README: more grammar and spelling corrections Most of them pointed out and corrected by uau.
2017-06-21 18:55:41 +00:00
There is no complete changelog; however, changes to the player core interface
README: add links to various changelogs We're too lazy to maintain a full changelog, but there are still a bunch of places which document specific changes. A user really should check them on each update, even if there are transition periods (including printing warnings etc.) for most changes. It's a good idea to give them more exposure by adding them to the README.
2016-11-15 22:42:33 +00:00
are listed in the [interface changelog][interface-changes].
Changes to the C API are documented in the [client API changelog][api-changes].
The [release list][releases] has a summary of most of the important changes
on every release.
README: more grammar and spelling corrections Most of them pointed out and corrected by uau.
2017-06-21 18:55:41 +00:00
Changes to the default key bindings are indicated in
README: add links to various changelogs We're too lazy to maintain a full changelog, but there are still a bunch of places which document specific changes. A user really should check them on each update, even if there are transition periods (including printing warnings etc.) for most changes. It's a good idea to give them more exposure by adding them to the README.
2016-11-15 22:42:33 +00:00
[restore-old-bindings.conf][restore-old-bindings].
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Compilation
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.
2012-11-13 06:25:28 +00:00
Compiling with full features requires development files for several
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
external libraries. One of the two build systems supported by mpv is required:
[meson](https://mesonbuild.com/index.html) or [waf](https://waf.io/). Meson
can be obtained from your distro or PyPI. Waf can be downloaded by using the
various: fix typos
2022-04-25 11:27:18 +00:00
`./bootstrap.py` script. It will get the latest version of waf that was tested
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
with mpv. Some documentation about the differences between the build systems are
located in [build-system-differences][build-system-differences].
switch the build system to waf This commit adds a new build system based on waf. configure and Makefile are deprecated effective immediately and someday in the future they will be removed (they are still available by running ./old-configure). You can find how the choice for waf came to be in `DOCS/waf-buildsystem.rst`. TL;DR: we couldn't get the same level of abstraction and customization with other build systems we tried (CMake and autotools). For guidance on how to build the software now, take a look at README.md and the cross compilation guide. CREDITS: This is a squash of ~250 commits. Some of them are not by me, so here is the deserved attribution: - @wm4 contributed some Windows fixes, renamed configure to old-configure and contributed to the bootstrap script. Also, GNU/Linux testing. - @lachs0r contributed some Windows fixes and the bootstrap script. - @Nikoli contributed a lot of testing and discovered many bugs. - @CrimsonVoid contributed changes to the bootstrap script.
2013-07-16 11:28:28 +00:00
build: officially deprecate waf While the waf build has served us well for many years, it's time to officially consider it deprecated. The meson build was added fully with the intention to eventually replace waf and its current state is more than good enough to do that. Let's start the deprecation period now to give users a heads up to switch before we remove waf for good.
2023-01-13 17:48:21 +00:00
**Note**: Building with waf is considered *deprecated* and will be removed in the
future.
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
### Meson
ci: use meson setup build instead of meson build The old "meson build" build command was actually deprecated a few months ago*. It turns out that you're supposed to use "meson setup build" instead which has been around for years. Go ahead and be a good citizen and update this in the CI. Also replace any mention of "meson build" with "meson setup build" in the documentation as well and change the one random hardcoded string we have in meson.build to "meson configure build" (might as well). *: https://github.com/mesonbuild/meson/commit/3c7ab542c0c4770241eae149b0d4cd8de329aee0
2022-10-29 02:40:53 +00:00
After creating your build directory (e.g. `meson setup build`), you can view a list
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
of all the build options via `meson configure build`. You could also just simply
look at the `meson_options.txt` file. Logs are stored in `meson-logs` within
your build directory.
Example:
ci: use meson setup build instead of meson build The old "meson build" build command was actually deprecated a few months ago*. It turns out that you're supposed to use "meson setup build" instead which has been around for years. Go ahead and be a good citizen and update this in the CI. Also replace any mention of "meson build" with "meson setup build" in the documentation as well and change the one random hardcoded string we have in meson.build to "meson configure build" (might as well). *: https://github.com/mesonbuild/meson/commit/3c7ab542c0c4770241eae149b0d4cd8de329aee0
2022-10-29 02:40:53 +00:00
meson setup build
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
meson compile -C build
meson install -C build
### Waf
switch the build system to waf This commit adds a new build system based on waf. configure and Makefile are deprecated effective immediately and someday in the future they will be removed (they are still available by running ./old-configure). You can find how the choice for waf came to be in `DOCS/waf-buildsystem.rst`. TL;DR: we couldn't get the same level of abstraction and customization with other build systems we tried (CMake and autotools). For guidance on how to build the software now, take a look at README.md and the cross compilation guide. CREDITS: This is a squash of ~250 commits. Some of them are not by me, so here is the deserved attribution: - @wm4 contributed some Windows fixes, renamed configure to old-configure and contributed to the bootstrap script. Also, GNU/Linux testing. - @lachs0r contributed some Windows fixes and the bootstrap script. - @Nikoli contributed a lot of testing and discovered many bugs. - @CrimsonVoid contributed changes to the bootstrap script.
2013-07-16 11:28:28 +00:00
For a list of the available build options use `./waf configure --help`. If
you think you have support for some feature installed but configure fails to
detect it, the file `build/config.log` may contain information about the
reasons for the failure.
build: hide duplicate options from `--help` Hide --enable variants from [autodetect]'ed options and --enable/--disable variants for [enable]'d/[disable]'d options. The hidden options are still usable, just hidden for more readability.
2013-12-14 13:59:07 +00:00
NOTE: To avoid cluttering the output with unreadable spam, `--help` only shows
waftools/features: add forgotten enable variants for enabled features This brings enabled features on the same level as disabled and auto-detected features by having both alternatives available. Looking at the commit message of 652895abdce4bc1ff2f00c7f21c0d0d722680806 this seems to have been the intent from the start, but this specific definition was missing from the option creation in Features.
2021-09-19 18:53:57 +00:00
one of the two switches for each option. If the option is autodetected or
enabled by default, the `--disable-***` switch is printed; if the option is
disabled by default, the `--enable-***` switch is printed. Either way, you can
use `--enable-***` or `--disable-**` regardless of what is printed by `--help`.
build: hide duplicate options from `--help` Hide --enable variants from [autodetect]'ed options and --enable/--disable variants for [enable]'d/[disable]'d options. The hidden options are still usable, just hidden for more readability.
2013-12-14 13:59:07 +00:00
README: mention build result being located at build/mpv
2013-11-23 10:14:22 +00:00
To build the software you can use `./waf build`: the result of the compilation
will be located in `build/mpv`. You can use `./waf install` to install mpv
to the *prefix* after it is compiled.
switch the build system to waf This commit adds a new build system based on waf. configure and Makefile are deprecated effective immediately and someday in the future they will be removed (they are still available by running ./old-configure). You can find how the choice for waf came to be in `DOCS/waf-buildsystem.rst`. TL;DR: we couldn't get the same level of abstraction and customization with other build systems we tried (CMake and autotools). For guidance on how to build the software now, take a look at README.md and the cross compilation guide. CREDITS: This is a squash of ~250 commits. Some of them are not by me, so here is the deserved attribution: - @wm4 contributed some Windows fixes, renamed configure to old-configure and contributed to the bootstrap script. Also, GNU/Linux testing. - @lachs0r contributed some Windows fixes and the bootstrap script. - @Nikoli contributed a lot of testing and discovered many bugs. - @CrimsonVoid contributed changes to the bootstrap script.
2013-07-16 11:28:28 +00:00
README: add example compilation commands Not sure if that helps.
2017-06-02 19:13:29 +00:00
Example:
./bootstrap.py
./waf configure
./waf
./waf install
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.
2012-11-13 06:25:28 +00:00
Essential dependencies (incomplete list):
- gcc or clang
Revert "x11: drop xscrnsaver use" This broke screensaver/powersave inhibition with at least KDE and LXDE. This is a release blocker. Since fdo, KDE and GNOME idiots seem to be unable to reach a consensus on a simple protocol, this seems unlikely to get fixed upstream this year, so revert this change. Fixes #4752. Breaks #4706 but I don’t give a damn. This reverts commit 3f75b3c3439241c209349908fa190c0382e44f05.
2017-08-20 07:11:26 +00:00
- X development headers (xlib, xrandr, xext, xscrnsaver, xinerama, libvdpau,
README: list some more X11 dependencies
2017-04-23 13:46:09 +00:00
libGL, GLX, EGL, xv, ...)
README: extend dependecy list, link Windows compilation docs Also, fix vo.rst, don't want to waste a separate commit on this.
2015-01-20 14:19:24 +00:00
- Audio output development headers (libasound/ALSA, pulseaudio)
- FFmpeg libraries (libavutil libavcodec libavformat libswscale libavfilter
Remove support for ffmpeg-mpv
2017-12-05 08:25:00 +00:00
and either libswresample or libavresample)
README: mention some more deps
2015-02-09 19:41:25 +00:00
- zlib
- iconv (normally provided by the system libc)
build: require recent libass Nobody should use an older version. It's perfectly backwards and forward compatible, so distros have no excuse not to package a recent version. Older versions lack tons of bug fixes (some of them crashing bugs, and potentially security relevant). With love to Debian, which is still on 0.10.2.
2015-02-18 20:11:53 +00:00
- libass (OSD, OSC, text subtitles)
README: mention that youtube-dl integration requires Lua
2015-01-30 10:13:14 +00:00
- Lua (optional, required for the OSC pseudo-GUI and youtube-dl integration)
README: extend dependecy list, link Windows compilation docs Also, fix vo.rst, don't want to waste a separate commit on this.
2015-01-20 14:19:24 +00:00
- libjpeg (optional, used for screenshots only)
README: suggest uchardet instead of Enca as dependency Enca is dead, uchardet is better (in half of all cases; on others it's worse).
2015-11-16 15:24:26 +00:00
- uchardet (optional, for subtitle charset detection)
README.md: minor cleanups I don't think MPlayer/mplayer2 and Libav are well-known enough anymore to warrant such a prominent place in the top-level README file of this project. It's just useless noise to most users. So I've moved these things to the FAQ. Update some other minor things.
2019-10-02 11:53:25 +00:00
- nvdec and vaapi libraries for hardware decoding on Linux (optional)
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
Libass dependencies (when building libass):
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
- gcc or clang, yasm on x86 and x86_64
- fribidi, freetype, fontconfig development headers (for libass)
README: update libass dependency harfbuzz as non-optional since libass 0.15 harfbuzz is no longer optional. Fixes #8412
2021-01-24 13:41:31 +00:00
- harfbuzz (required for correct rendering of combining characters, particularly
for correct rendering of non-English text on OSX, and Arabic/Indic scripts on
any platform)
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
FFmpeg dependencies (when building FFmpeg):
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
- gcc or clang, yasm on x86 and x86_64
README: more grammar and spelling corrections Most of them pointed out and corrected by uau.
2017-06-21 18:55:41 +00:00
- OpenSSL or GnuTLS (have to be explicitly enabled when compiling FFmpeg)
- libx264/libmp3lame/libfdk-aac if you want to use encoding (have to be
explicitly enabled when compiling FFmpeg)
README: mention some semi-required FFmpeg dependencies I think DASH playback tends to work much better with FFmpeg's DASH demuxer, which requires libxml2. For nvdec, FFmpeg git master now requires the external nvidia headers, since the builtin ones were removed.
2018-03-01 11:24:04 +00:00
- For native DASH playback, FFmpeg needs to be built with --enable-libxml2
README: fix typo
2019-12-03 23:40:39 +00:00
(although there are security implications, and DASH support has lots of bugs).
README.md: minor cleanups I don't think MPlayer/mplayer2 and Libav are well-known enough anymore to warrant such a prominent place in the top-level README file of this project. It's just useless noise to most users. So I've moved these things to the FAQ. Update some other minor things.
2019-10-02 11:53:25 +00:00
- AV1 decoding support requires dav1d.
README: mention some semi-required FFmpeg dependencies I think DASH playback tends to work much better with FFmpeg's DASH demuxer, which requires libxml2. For nvdec, FFmpeg git master now requires the external nvidia headers, since the builtin ones were removed.
2018-03-01 11:24:04 +00:00
- For good nvidia support on Linux, make sure nv-codec-headers is installed
and can be found by configure.
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.
2012-11-13 06:25:28 +00:00
Most of the above libraries are available in suitable versions on normal
Remove support for ffmpeg-mpv
2017-12-05 08:25:00 +00:00
Linux distributions. For ease of compiling the latest git master of everything,
you may wish to use the separately available build wrapper ([mpv-build][mpv-build])
which first compiles FFmpeg libraries and libass, and then compiles the player
statically linked against those.
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.
2012-11-13 06:25:28 +00:00
README: extend dependecy list, link Windows compilation docs Also, fix vo.rst, don't want to waste a separate commit on this.
2015-01-20 14:19:24 +00:00
If you want to build a Windows binary, you either have to use MSYS2 and MinGW,
Switch demuxing and decoding to GStreamer (finally FFmpeg independence!) README.md: fix linebreaks It's only a README, but the 80 columns limit should be followed.
2017-04-01 11:42:03 +00:00
or cross-compile from Linux with MinGW. See
[Windows compilation][windows_compilation].
README: extend dependecy list, link Windows compilation docs Also, fix vo.rst, don't want to waste a separate commit on this.
2015-01-20 14:19:24 +00:00
README: add something about system requirements This is actually all bullshit. There are many factors that can ruin the video playback experience (and most outside of our or the user's control). One thing that makes sense is that this declares incompatibility with Windows XP (fixes #2473).
2015-11-22 17:19:35 +00:00
README: edit release section, add section about preferred FFmpeg version All using properly seasoned words.
2016-03-07 13:44:14 +00:00
## Release cycle
DOCS: add document describing the release policy and procedure
2014-06-24 11:36:15 +00:00
README: edit release section, add section about preferred FFmpeg version All using properly seasoned words.
2016-03-07 13:44:14 +00:00
Every other month, an arbitrary git snapshot is made, and is assigned
a 0.X.0 version number. No further maintenance is done.
DOCS: add document describing the release policy and procedure
2014-06-24 11:36:15 +00:00
README: edit release section, add section about preferred FFmpeg version All using properly seasoned words.
2016-03-07 13:44:14 +00:00
The goal of releases is to make Linux distributions happy. Linux distributions
are also expected to apply their own patches in case of bugs and security
issues.
README: describe release cycle
2014-05-20 00:31:44 +00:00
Releases other than the latest release are unsupported and unmaintained.
DOCS: add document describing the release policy and procedure
2014-06-24 11:36:15 +00:00
See the [release policy document][release-policy] for more information.
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Bug reports
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.
2012-11-13 06:25:28 +00:00
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug
README: more grammar and spelling corrections Most of them pointed out and corrected by uau.
2017-06-21 18:55:41 +00:00
reports or feature requests. Follow the template's instructions or the issue
will likely be ignored or closed as invalid.
Using the bug tracker as place for simple questions is fine but IRC is
recommended (see [Contact](#Contact) below).
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.
2012-11-13 06:25:28 +00:00
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Contributing
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.
2012-11-13 06:25:28 +00:00
README.md: explicitly link contribute.md Also move the license section, because it looks strange how the link list is above it.
2017-10-09 14:00:08 +00:00
Please read [contribute.md][contribute.md].
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.
2012-11-13 06:25:28 +00:00
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.
README: missing correction from previous commit Also add links pointing to wiki and issue tracker feature requests for new contributions.
2017-06-21 19:52:55 +00:00
You can check [the wiki](https://github.com/mpv-player/mpv/wiki/Stuff-to-do)
README: fix link to feature-request issues
2021-05-28 07:45:10 +00:00
or the [issue tracker](https://github.com/mpv-player/mpv/issues?q=is%3Aopen+is%3Aissue+label%3Ameta%3Afeature-request)
README: missing correction from previous commit Also add links pointing to wiki and issue tracker feature requests for new contributions.
2017-06-21 19:52:55 +00:00
for ideas on what you could contribute with.
README.md: explicitly link contribute.md Also move the license section, because it looks strange how the link list is above it.
2017-10-09 14:00:08 +00:00
## License
Copyright: some more licensing clarifications Unfortunately I'm also adding the full text of the LGPL license text, because the GPL one was already present in this repository, and I don't want to imply that the GPL somehow has priority.
2017-10-13 13:37:55 +00:00
GPLv2 "or later" by default, LGPLv2.1 "or later" with `--enable-lgpl`.
See [details.](https://github.com/mpv-player/mpv/blob/master/Copyright)
README.md: explicitly link contribute.md Also move the license section, because it looks strange how the link list is above it.
2017-10-09 14:00:08 +00:00
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
## History
This software is based on the MPlayer project. Before mpv existed as a project,
the code base was briefly developed under the mplayer2 project. For details,
README.md: fix dead FAQ link due to syntax error
2019-11-09 04:28:47 +00:00
see the [FAQ][FAQ].
README.md: explicitly link contribute.md Also move the license section, because it looks strange how the link list is above it.
2017-10-09 14:00:08 +00:00
Update README.md Signed-off-by: wm4 <wm4@nowhere>
2015-04-03 16:20:59 +00:00
## Contact
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.
2012-11-13 06:25:28 +00:00
README: more grammar and spelling corrections Most of them pointed out and corrected by uau.
2017-06-21 18:55:41 +00:00
Most activity happens on the IRC channel and the github issue tracker.
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
Improve readme aesthetics. This fixes the line under the header, creates a title header, and slightly improves list formatting.
2018-09-23 03:34:38 +00:00
- **GitHub issue tracker**: [issue tracker][issue-tracker] (report bugs here)
{ci,docs,README}: update IRC references to new network
2021-06-08 14:34:01 +00:00
- **User IRC Channel**: `#mpv` on `irc.libera.chat`
- **Developer IRC Channel**: `#mpv-devel` on `irc.libera.chat`
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
README.md: reduce focus on MPlayer, small improvements MPlayer isn't all too well-known anymore. It does not make sense to "advertise" with it (and it actually never did). The GPU comment needed clarification. I think originally, it was just to signal that you'll have a bad time with Intel. Make that broader.
2019-11-02 18:15:59 +00:00
[FAQ]: https://github.com/mpv-player/mpv/wiki/FAQ
README: add some better links Also write something about MPlayer, since this is a frequently asked question.
2015-03-04 11:03:24 +00:00
[releases]: https://github.com/mpv-player/mpv/releases
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
[mpv-build]: https://github.com/mpv-player/mpv-build
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
[issue-tracker]: https://github.com/mpv-player/mpv/issues
README: fix link to release policy document
2014-06-30 21:23:50 +00:00
[release-policy]: https://github.com/mpv-player/mpv/blob/master/DOCS/release-policy.md
README: extend dependecy list, link Windows compilation docs Also, fix vo.rst, don't want to waste a separate commit on this.
2015-01-20 14:19:24 +00:00
[windows_compilation]: https://github.com/mpv-player/mpv/blob/master/DOCS/compile-windows.md
README: add links to various changelogs We're too lazy to maintain a full changelog, but there are still a bunch of places which document specific changes. A user really should check them on each update, even if there are transition periods (including printing warnings etc.) for most changes. It's a good idea to give them more exposure by adding them to the README.
2016-11-15 22:42:33 +00:00
[interface-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/interface-changes.rst
[api-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst
[restore-old-bindings]: https://github.com/mpv-player/mpv/blob/master/etc/restore-old-bindings.conf
README.md: explicitly link contribute.md Also move the license section, because it looks strange how the link list is above it.
2017-10-09 14:00:08 +00:00
[contribute.md]: https://github.com/mpv-player/mpv/blob/master/DOCS/contribute.md
build: add meson build support Adds support for the meson build system as well as a bit of documentation. Compatibility with the existing waf build is maintained.
2021-11-07 19:28:16 +00:00
[build-system-differences]: https://github.com/mpv-player/mpv/blob/master/DOCS/build-system-differences.md