Qt: reindent
[vlc.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index ab1379a..e587f4f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,37 +1,68 @@
-INSTALL file for vlc, the VideoLAN Client
+INSTALL file for the VLC media player
 
+More extensive information for *nix, Windows, Mac OS X and BeOS users can be
+found here: http://developers.videolan.org/vlc/
 
-Building VideoLAN
+Bootstrapping VLC
 =================
 
-A typical way to configure the vlc is :
+If you retrieved VLC from the git server and do not have a "configure"
+script, please refer to the HACKING file.
 
-   ./configure --prefix=/usr --enable-ppro --enable-mmx --enable-gnome
+Configuring VLC
+===============
 
-See `./configure --help' for more information.
+A typical way to configure VLC is:
 
-Then, run `make', and `make install' to install it.
+   ./configure --prefix=/usr
 
+See `./configure --help' for more information.
 
-To build a Debian package, you may use :
+If you intend to debug stuff, you may want to compile with debugging
+symbols:
 
-   dpkg-buildpackage -rfakeroot -us -uc
+   make distclean ; ./configure --prefix=/usr --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 3.3 or higher is
+required. On older systems (e.g. FreeBSD 4.x, BeOS), please select a more
+recent version manually by setting the CC and CXX environment variables
+appropriately while running the ./configure shell script.
 
-To build RedHat packages, use :
 
-   rpm -ba vlc.spec
+Building VLC
+============
 
+Once configured, run `make' to build VLC.
 
-Installing and running VideoLAN
-===============================
 
-You can install the vlc and its plugins by typing :
+Installing and running VLC
+==========================
+
+You can install the VLC and its plugins by typing:
 
    make install
 
-But you don't need to do it if you don't want ; vlc can be launched
-from the current directory as well :
+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
 
+
+Building packages
+=================
+
+To build a Debian package, you need to get the packaging info
+   svn co svn://svn.debian.org/pkg-multimedia/videolan/vlc/debian debian 
+and then
+   dpkg-buildpackage -rfakeroot -us -uc
+
+
+To build RPM packages, copy a spec file from extra/package/rpm and:
+
+   rpm -ba vlc.spec
+
+To build an ipkg package (iPAQ familiar Linux), use:
+
+   ipkg-buildpackage
+