demux: ts: fix offset units
[vlc.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 7faafaf..6cc57b9 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,47 +1,55 @@
-INSTALL file for vlc, the VideoLAN Client
+INSTALL file for the VLC media player
+=====================================
 
+More extensive information for *nix, Windows and Mac OS X users can be
+found here: http://wiki.videolan.org/Compile_VLC
 
-Configuring VideoLAN
-====================
+People installing VLC for Windows from source MUST read:
+http://wiki.videolan.org/Win32Compile
 
-A typical way to configure vlc is:
+Bootstrapping VLC
+=================
 
-   ./configure --prefix=/usr --enable-gnome --with-sdl
+If you retrieved VLC from the git server and do not have yet a "configure"
+script, please run:
 
-See `./configure --help' for more information.
+    ./bootstrap
+
+Configuring VLC
+===============
 
-Here is a shortcut to copy-paste for a complete build:
+A typical way to configure VLC is:
 
-   make distclean && ./configure --prefix=/usr --enable-gnome \
-      --enable-fb --with-glide --with-ggi --with-sdl --enable-esd \
-      --enable-mga --enable-gtk --enable-qt --enable-xvideo
+   ./configure
 
-If you intend to debug stuff, you may want to disable optimizations:
+See `./configure --help' for more information.
 
-   make distclean && ./configure --prefix=/usr --enable-gnome \
-      --enable-fb --with-glide --with-ggi --with-sdl --enable-esd \
-      --enable-mga --enable-gtk --enable-qt --enable-xvideo \
-      --disable-optimizatons
+If you intend to debug stuff, you may want to compile with debugging
+symbols:
 
+   make distclean ; ./configure --enable-debug
+
+We recommend using GCC to build VLC, though some people reported success
+with the Intel C compiler (version 8) as well. GCC version 4.8 or higher is
+required. On older systems (e.g. FreeBSD 4.x), please select a more recent
+version manually by setting the CC and CXX environment variables
+appropriately while running the ./configure shell script.
 
-Building VideoLAN
-=================
 
-Have a look at the generated Makefile.opts file, you may want to choose
-which modules will be compiled as plugins, and which ones will remain in
-the core application. The configure script tries to guess for you.
+Building VLC
+============
 
-Once configured, run `make' to build vlc.
+Once configured, run `make' to build VLC.
 
 
-Installing and running VideoLAN
-===============================
+Installing and running VLC
+==========================
 
-You can install the vlc and its plugins by typing:
+You can install the VLC and its plugins by typing:
 
    make install
 
-But you don't need to install it if you don't want to; vlc can be launched
+But you don't need to install it if you don't want to; VLC can be launched
 from the current directory as well:
 
    ./vlc
@@ -50,12 +58,7 @@ from the current directory as well:
 Building packages
 =================
 
-To build a Debian package, you may use:
-
-   dpkg-buildpackage -rfakeroot -us -uc
-
-
-To build RedHat packages, use:
-
-   rpm -ba vlc.spec
-
+To build a Debian package, you need to get the packaging info
+   git clone git://git.debian.org/pkg-multimedia/vlc.git debian
+and then
+   git-buildpackage