From 28f37b1887aabfb40b166b50a3127293231a9370 Mon Sep 17 00:00:00 2001 From: wm4 Date: Fri, 1 Feb 2013 13:23:12 +0100 Subject: Change README to .rst --- README | 41 -------------------------------------- README.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 41 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index 2b8c492..0000000 --- a/README +++ /dev/null @@ -1,41 +0,0 @@ -This is a collection of scripts to make downloading and building mpv, ffmpeg -and libass easier. ffmpeg and libass get special treatment, because they are -essential, and distribution packages are often too old or too broken. - -Update the ffmpeg, libass and mpv sources with the following command: - - ./update - -This is also needed before doing the first build after the initial checkout. - -Build mpv and ffmpeg/libass with: - - make clean # sometimes needed to build successfully - make - -Install mpv with: - - sudo make install - -Or if you don't want debugging symbols (smaller binaries): - - sudo make install-strip - -mpv doesn't need to be installed. The binary ./mpv/mpv can be used as-is. Note -that libass and ffmpeg will be statically linked with mpv when using the -provided scripts, and no ffmpeg or libass libraries are/need to be installed. - -Essential dependencies (incomplete list): -- gcc, yasm -- X development headers (xlib, X extensions, vdpau, GL, Xv, ...) -- Audio output development headers (libasound, pulseaudio) -- fribidi, freetype, fontconfig development headers (for libass) -- libjpeg -- libquvi if you want to play Youtube videos directly -- libx264 if you want to use encoding (you have to add --enable-libx264 to - scripts/ffmpeg-config, because ffmpeg doesn't autodetect this library) - -Note: most dependencies are optional and autodetected. If they're missing, -these features will be disabled silently. This includes some dependencies -which could be considered essential. - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d110274 --- /dev/null +++ b/README.rst @@ -0,0 +1,67 @@ +Overview +======== + +This is a collection of scripts to make downloading and building mpv, ffmpeg +and libass easier. ffmpeg and libass get special treatment, because they are +essential, and distribution packages are often too old or too broken. + +Instructions +============ + +Checkout the build repo: + + git clone https://github.com/mpv-player/mpv-build.git + + cd mpv-build + +Get the ffmpeg, libass and mpv sources with the following command: + + ./update + +(This is always needed before doing the first build after the initial checkout, +and can be used later to update ffmpeg/libass/mpv later.) + +Build mpv and ffmpeg/libass with: + + make clean # sometimes needed to build successfully + + make + +Install mpv with: + + sudo make install + +Or if you don't want debugging symbols (smaller binaries): + + sudo make install-strip + +mpv doesn't need to be installed. The binary ./mpv/mpv can be used as-is. Note +that libass and ffmpeg will be statically linked with mpv when using the +provided scripts, and no ffmpeg or libass libraries are/need to be installed. + +Dependencies +============ + +Essential dependencies (incomplete list): + +- gcc, yasm, git +- X development headers (xlib, X extensions, vdpau, GL, Xv, ...) +- Audio output development headers (libasound, pulseaudio) +- fribidi, freetype, fontconfig development headers (for libass) +- libjpeg +- libquvi if you want to play Youtube videos directly +- libx264 if you want to use encoding (you have to add --enable-libx264 to + scripts/ffmpeg-config, because ffmpeg doesn't autodetect this library) + +Note: most dependencies are optional and autodetected. If they're missing, +these features will be disabled silently. This includes some dependencies +which could be considered essential. + +On Debian or Ubuntu systems, you can use this command to get most of +the required dependencies: + + apt-get build-dep mplayer + +mpv has similar dependencies as mplayer, although there is some +mismatch. + -- cgit v1.2.3